Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class GristDocument

    A Grist document, containing one or more tables.

    Inheritance
    object
    GristDocument
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Grist4NET
    Assembly: Grist4NET.dll
    Syntax
    public class GristDocument

    Fields

    DocumentId

    Declaration
    public readonly string DocumentId
    Field Value
    Type Description
    string

    Properties

    CreatedAt

    Declaration
    public DateTime CreatedAt { get; }
    Property Value
    Type Description
    DateTime

    Name

    Declaration
    public string Name { get; }
    Property Value
    Type Description
    string

    Tables

    Declaration
    public IReadOnlyDictionary<string, GristTableMetadata> Tables { get; }
    Property Value
    Type Description
    IReadOnlyDictionary<string, GristTableMetadata>
    See Also
    GetTable(string)

    UpdatedAt

    Declaration
    public DateTime UpdatedAt { get; }
    Property Value
    Type Description
    DateTime

    Methods

    GetAttachment(ulong)

    Declaration
    public Task<GristAttachment> GetAttachment(ulong attachmentRef)
    Parameters
    Type Name Description
    ulong attachmentRef
    Returns
    Type Description
    Task<GristAttachment>

    GetTable(string)

    Declaration
    public Task<GristTable> GetTable(string tableId)
    Parameters
    Type Name Description
    string tableId
    Returns
    Type Description
    Task<GristTable>

    Refresh()

    Retrieves the document's current structure from Grist and syncs it with this instance

    Declaration
    public Task Refresh()
    Returns
    Type Description
    Task

    See Also

    GetDocument(string)
    In this article
    Back to top Generated by DocFX