Class GristTable

A table within a Grist document. Provides methods to manipulate data.

Inheritance

object

GristTableMetadata

GristTable

Inherited Members

GristTableMetadata.TableRef

GristTableMetadata.TableId

GristTableMetadata.OnDemand

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 GristTable : GristTableMetadata

Properties

Columns

Declaration

public IReadOnlyDictionary<string, GristColumn> Columns { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, GristColumn>

Document

Declaration

public GristDocument Document { get; }

Property Value

Type	Description
GristDocument

DocumentId

Declaration

public string DocumentId { get; }

Property Value

Type	Description
string

Methods

BindRecordsWithId<T>(params IGristRecordFilter[])

Declaration

public Task<IDictionary<ulong, T>> BindRecordsWithId<T>(params IGristRecordFilter[] filters) where T : new()

Parameters

Type	Name	Description
IGristRecordFilter[]	filters

Returns

Type	Description
Task<IDictionary<ulong, T>>

Type Parameters

Name	Description
T

BindRecordsWithId<T>(Func<T>, ulong, params IGristRecordFilter[])

Declaration

public Task<IDictionary<ulong, T>> BindRecordsWithId<T>(Func<T> instantiator, ulong limit, params IGristRecordFilter[] filters)

Parameters

Type	Name	Description
Func<T>	instantiator
ulong	limit
IGristRecordFilter[]	filters

Returns

Type	Description
Task<IDictionary<ulong, T>>

Type Parameters

Name	Description
T

BindRecordsWithId<T>(ulong, params IGristRecordFilter[])

Declaration

public Task<IDictionary<ulong, T>> BindRecordsWithId<T>(ulong limit, params IGristRecordFilter[] filters) where T : new()

Parameters

Type	Name	Description
ulong	limit
IGristRecordFilter[]	filters

Returns

Type	Description
Task<IDictionary<ulong, T>>

Type Parameters

Name	Description
T

BindRecords<T>(params IGristRecordFilter[])

Declaration

public Task<ICollection<T>> BindRecords<T>(params IGristRecordFilter[] filters) where T : new()

Parameters

Type	Name	Description
IGristRecordFilter[]	filters

Returns

Type	Description
Task<ICollection<T>>

Type Parameters

Name	Description
T

BindRecords<T>(Func<T>, ulong, params IGristRecordFilter[])

Declaration

public Task<ICollection<T>> BindRecords<T>(Func<T> instantiator, ulong limit, params IGristRecordFilter[] filters)

Parameters

Type	Name	Description
Func<T>	instantiator
ulong	limit
IGristRecordFilter[]	filters

Returns

Type	Description
Task<ICollection<T>>

Type Parameters

Name	Description
T

BindRecords<T>(ulong, params IGristRecordFilter[])

Declaration

public Task<ICollection<T>> BindRecords<T>(ulong limit, params IGristRecordFilter[] filters) where T : new()

Parameters

Type	Name	Description
ulong	limit
IGristRecordFilter[]	filters

Returns

Type	Description
Task<ICollection<T>>

Type Parameters

Name	Description
T

CountRecords()

Counts the total number of records within a table without retrieving them using an SQL query

Declaration

public Task<ulong> CountRecords()

Returns

Type	Description
Task<ulong>

GetRecords(params IGristRecordFilter[])

Declaration

public Task<ICollection<IDictionary<string, object?>>> GetRecords(params IGristRecordFilter[] filters)

Parameters

Type	Name	Description
IGristRecordFilter[]	filters

Returns

Type	Description
Task<ICollection<IDictionary<string, object>>>

GetRecords(ulong, params IGristRecordFilter[])

Declaration

public Task<ICollection<IDictionary<string, object?>>> GetRecords(ulong limit, params IGristRecordFilter[] filters)

Parameters

Type	Name	Description
ulong	limit
IGristRecordFilter[]	filters

Returns

Type	Description
Task<ICollection<IDictionary<string, object>>>

GetRecordsWithId(params IGristRecordFilter[])

Declaration

public Task<IDictionary<ulong, IDictionary<string, object?>>> GetRecordsWithId(params IGristRecordFilter[] filters)

Parameters

Type	Name	Description
IGristRecordFilter[]	filters

Returns

Type	Description
Task<IDictionary<ulong, IDictionary<string, object>>>

GetRecordsWithId(ulong, params IGristRecordFilter[])

Declaration

public Task<IDictionary<ulong, IDictionary<string, object?>>> GetRecordsWithId(ulong limit, params IGristRecordFilter[] filters)

Parameters

Type	Name	Description
ulong	limit
IGristRecordFilter[]	filters

Returns

Type	Description
Task<IDictionary<ulong, IDictionary<string, object>>>

Refresh()

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

Declaration

public Task Refresh()

Returns

Type	Description
Task