Class IgbBaseDataSource

Provides a base implementation of IDataSource that data source implementations can further extend.

Inheritance

System.Object

BaseRendererElement

IgbBaseDataSource

IgbLocalDataSource

IgbVirtualDataSource

Implements

JsonSerializable

Inherited Members

BaseRendererElement._name

BaseRendererElement.eventCallbacksCache

BaseRendererElement._cachedSerializedContent

BaseRendererElement.EnsureModulesLoaded()

BaseRendererElement.BuildRenderTree(RenderTreeBuilder)

BaseRendererElement.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererElement.InvokeMethod(String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodSync(String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodHelper(String, String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodHelperSync(String, String, Object[], String[], ElementReference[])

BaseRendererElement.IsPropDirty(String)

BaseRendererElement.Serialize(SerializationContext, String)

BaseRendererElement.Serialize()

BaseRendererElement.EnsureValid()

BaseRendererElement.FromEventJson(BaseRendererControl, Dictionary<String, Object>)

BaseRendererElement.ToEventJson(BaseRendererControl, Dictionary<String, Object>)

BaseRendererElement.SetResourceStringAsync(String, String, String)

BaseRendererElement.SetResourceStringAsync(String, String)

BaseRendererElement.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)

BaseRendererElement.IgBlazor

BaseRendererElement.IsComponentRooted

BaseRendererElement.ParentTypeName

BaseRendererElement.UseDirectRender

BaseRendererElement.ChildContent

BaseRendererElement.SupportsVisualChildren

BaseRendererElement.Name

BaseRendererElement.Parent

BaseRendererElement.MethodTarget

BaseRendererElement.CurrParent

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbBaseDataSource : BaseRendererElement, JsonSerializable

Constructors

IgbBaseDataSource()

Declaration

public IgbBaseDataSource()

Properties

ActualCount

Gets the current actual full count of the items in the data source.

Declaration

public int ActualCount { get; set; }

Property Value

Type	Description
System.Int32

DeferAutoRefresh

Gets or sets whether the auto refresh mechanism of the data source is currently defered. The data source will not react to most setting changes while this is set to true an will instead defer processing. Setting this value to false will queue a new refresh.

Declaration

public bool DeferAutoRefresh { get; set; }

Property Value

Type	Description
System.Boolean

FirstVisibleIndexRequested

Gets or sets which index consumers of the data source desire to be the current first visible index. A grid, for example, would indicate the current visible top row, and update this as that changes.

Declaration

public int FirstVisibleIndexRequested { get; set; }

Property Value

Type	Description
System.Int32

IncludeSummaryRowsInSection

Gets or sets whether the data source should include summary rows inside the group when summaries are present.

Declaration

public virtual bool IncludeSummaryRowsInSection { get; set; }

Property Value

Type	Description
System.Boolean

IsBatchingEnabled

Gets or sets whether batch edits are enabled.

Declaration

public virtual bool IsBatchingEnabled { get; set; }

Property Value

Type	Description
System.Boolean

IsReadOnly

Gets or sets whether the data source is read-only or not.

Declaration

public bool IsReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionCollapsable

Gets or sets if sections are collapsable.

Declaration

public virtual bool IsSectionCollapsable { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionContentVisible

Gets or sets whether content besides the section headers are displayed.

Declaration

public virtual bool IsSectionContentVisible { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionExpandedDefault

Gets or sets whether sections default to expanded or collapsed when they are created.

Declaration

public virtual bool IsSectionExpandedDefault { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionHeaderNormalRow

Gets or sets whether the section headers are treated as normal rows.

Declaration

public virtual bool IsSectionHeaderNormalRow { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionSummaryRowsAtBottom

Gets or sets whether the summary rows within a section are placed at the bottom of the section, otherwise they will be placed at the top.

Declaration

public virtual bool IsSectionSummaryRowsAtBottom { get; set; }

Property Value

Type	Description
System.Boolean

LastVisibleIndexRequested

Gets or sets which index consumers of the data source desire to be the current last visible index. A grid, for example, would indicate the current visible top row, and update this as that changes.

Declaration

public int LastVisibleIndexRequested { get; set; }

Property Value

Type	Description
System.Int32

PrimaryKey

Gets or sets a list of property references that indicate the user provided primary key of the items in the data source. Consumers of the data source will often need to uniquely identify items in the data source. For this purpose a primary key should be specified.

Declaration

public string[] PrimaryKey { get; set; }

Property Value

Type	Description
System.String[]

PropertiesRequested

Gets or sets a list of property references for the properties desired by the consumer of the data source. If known, the data source may take steps to request only those properties, or to ensure that those properties are included, rather than the default behavior for this type of data source.

Declaration

public string[] PropertiesRequested { get; set; }

Property Value

Type	Description
System.String[]

PropertiesRequestedChanged

Declaration

public EventCallback<IgbDataSourcePropertiesRequestedChangedEventArgs> PropertiesRequestedChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataSourcePropertiesRequestedChangedEventArgs>

PropertiesRequestedChangedScript

Declaration

public string PropertiesRequestedChangedScript { get; set; }

Property Value

Type	Description
System.String

RootSummariesChanged

Declaration

public EventCallback<IgbDataSourceRootSummariesChangedEventArgs> RootSummariesChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataSourceRootSummariesChangedEventArgs>

RootSummariesChangedScript

Declaration

public string RootSummariesChangedScript { get; set; }

Property Value

Type	Description
System.String

RowExpansionChanged

Declaration

public EventCallback<IgbDataSourceRowExpansionChangedEventArgs> RowExpansionChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataSourceRowExpansionChangedEventArgs>

RowExpansionChangedScript

Declaration

public string RowExpansionChangedScript { get; set; }

Property Value

Type	Description
System.String

SchemaChanged

Declaration

public EventCallback<IgbDataSourceSchemaChangedEventArgs> SchemaChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataSourceSchemaChangedEventArgs>

SchemaChangedScript

Declaration

public string SchemaChangedScript { get; set; }

Property Value

Type	Description
System.String

SchemaIncludedProperties

Declaration

public string[] SchemaIncludedProperties { get; set; }

Property Value

Type	Description
System.String[]

SectionHeaderDisplayMode

Gets or sets how section headers are displayed.

Declaration

public virtual DataSourceSectionHeaderDisplayMode SectionHeaderDisplayMode { get; set; }

Property Value

Type	Description
DataSourceSectionHeaderDisplayMode

ShouldEmitSectionFooters

Declaration

public bool ShouldEmitSectionFooters { get; set; }

Property Value

Type	Description
System.Boolean

ShouldEmitSectionHeaders

Declaration

public bool ShouldEmitSectionHeaders { get; set; }

Property Value

Type	Description
System.Boolean

ShouldEmitShiftedRows

Declaration

public bool ShouldEmitShiftedRows { get; set; }

Property Value

Type	Description
System.Boolean

ShouldEmitSummaryRows

Declaration

public bool ShouldEmitSummaryRows { get; set; }

Property Value

Type	Description
System.Boolean

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererElement.Type

Methods

AcceptPendingCommit(Int32)

Declaration

public void AcceptPendingCommit(int commitID)

Parameters

Type	Name	Description
System.Int32	commitID

AcceptPendingCommitAsync(Int32)

Accepts a commit with the provided ID.

Declaration

public Task AcceptPendingCommitAsync(int commitID)

Parameters

Type	Name	Description
System.Int32	commitID	The ID of the commit to accept.

Returns

Type	Description
System.Threading.Tasks.Task

AcceptPendingTransaction(Int32)

Declaration

public void AcceptPendingTransaction(int transactionID)

Parameters

Type	Name	Description
System.Int32	transactionID

AcceptPendingTransactionAsync(Int32)

Save a specific pending transaction.

Declaration

public Task AcceptPendingTransactionAsync(int transactionID)

Parameters

Type	Name	Description
System.Int32	transactionID	The unique transaction ID.

Returns

Type	Description
System.Threading.Tasks.Task

AddItem(Object)

Declaration

public void AddItem(object item)

Parameters

Type	Name	Description
System.Object	item

AddItemAsync(Object)

Declaration

public Task AddItemAsync(object item)

Parameters

Type	Name	Description
System.Object	item

Returns

Type	Description
System.Threading.Tasks.Task

CancelEdits()

Declaration

public void CancelEdits()

CancelEditsAsync()

Cancels any batched edits that may exist.

Declaration

public Task CancelEditsAsync()

Returns

Type	Description
System.Threading.Tasks.Task

ClearPinnedRows()

Declaration

public virtual void ClearPinnedRows()

ClearPinnedRowsAsync()

Declaration

public virtual Task ClearPinnedRowsAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Clone()

Declaration

public virtual DataSource Clone()

Returns

Type	Description
DataSource

CloneAsync()

Clones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance.

Declaration

public virtual Task<DataSource> CloneAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DataSource>

CloneProperties(DataSource)

Declaration

public virtual void CloneProperties(DataSource dataSource)

Parameters

Type	Name	Description
DataSource	dataSource

ClonePropertiesAsync(DataSource)

Clones the properties over to the provided datasource.

Declaration

public virtual Task ClonePropertiesAsync(DataSource dataSource)

Parameters

Type	Name	Description
DataSource	dataSource	The datasource to update.

Returns

Type	Description
System.Threading.Tasks.Task

CommitEdits(Boolean)

Declaration

public int CommitEdits(bool isPending)

Parameters

Type	Name	Description
System.Boolean	isPending

Returns

Type	Description
System.Int32

CommitEditsAsync(Boolean)

Commit the current edits to the datasource.

Declaration

public Task<int> CommitEditsAsync(bool isPending)

Parameters

Type	Name	Description
System.Boolean	isPending	Whether this should be a pending commit which waits to be accepted or rejected at a later time.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

BaseRendererElement.FindByName(String)

FlushAutoRefresh()

Declaration

public void FlushAutoRefresh()

FlushAutoRefreshAsync()

Called to make sure a queued refresh of the data source has been applied before continuing. Should only be needed if you are trying to synchronously examine the results of changing settings on the data source. Note, for a virtual data source, the data source itself may be waiting for other synchronous requests to actualize data. This call will not wait for those, but will only make sure the appropriate requests are in flight from the settings changes

Declaration

public Task FlushAutoRefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

GetAggregatedChanges(Int32)

Declaration

public IgbDataSourceAggregatedResult[] GetAggregatedChanges(int commitID)

Parameters

Type	Name	Description
System.Int32	commitID

Returns

Type	Description
IgbDataSourceAggregatedResult[]

GetAggregatedChangesAsync(Int32)

Returns a set of changes that have been made to the data however have not been committed yet.

Declaration

public Task<IgbDataSourceAggregatedResult[]> GetAggregatedChangesAsync(int commitID)

Parameters

Type	Name	Description
System.Int32	commitID	The ID for the pending commit you want. -1 for the current changes.

Returns

Type	Description
System.Threading.Tasks.Task<IgbDataSourceAggregatedResult[]>

GetIsRowExpandedAtIndex(Int32)

Declaration

public virtual bool GetIsRowExpandedAtIndex(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex

Returns

Type	Description
System.Boolean

GetIsRowExpandedAtIndexAsync(Int32)

Gets the expansion state for a row.

Declaration

public virtual Task<bool> GetIsRowExpandedAtIndexAsync(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	The row to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

GetItemAtIndex(Int32)

Declaration

public virtual object GetItemAtIndex(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Object

GetItemAtIndexAsync(Int32)

Returns the item at the specific index in the data source. This index is based on the data source's current view of the data, not the actual underlying indexes of the original source.

Declaration

public virtual Task<object> GetItemAtIndexAsync(int index)

Parameters

Type	Name	Description
System.Int32	index	The index of the requested item.

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

GetItemFromKey(Object[])

Declaration

public virtual object GetItemFromKey(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Object

GetItemFromKeyAsync(Object[])

Declaration

public virtual Task<object> GetItemFromKeyAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

GetItemProperty(Object, String)

Declaration

public virtual object GetItemProperty(object item, string propertyName)

Parameters

Type	Name	Description
System.Object	item
System.String	propertyName

Returns

Type	Description
System.Object

GetItemPropertyAsync(Object, String)

Declaration

public virtual Task<object> GetItemPropertyAsync(object item, string propertyName)

Parameters

Type	Name	Description
System.Object	item
System.String	propertyName

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

GetItemPropertyAtIndex(Int32, String)

Declaration

public virtual object GetItemPropertyAtIndex(int index, string valueName)

Parameters

Type	Name	Description
System.Int32	index
System.String	valueName

Returns

Type	Description
System.Object

GetItemPropertyAtIndexAsync(Int32, String)

Declaration

public virtual Task<object> GetItemPropertyAtIndexAsync(int index, string valueName)

Parameters

Type	Name	Description
System.Int32	index
System.String	valueName

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

GetMainValuePath(DataSourceRowType)

Declaration

public virtual string GetMainValuePath(DataSourceRowType rowType)

Parameters

Type	Name	Description
DataSourceRowType	rowType

Returns

Type	Description
System.String

GetMainValuePathAsync(DataSourceRowType)

Declaration

public virtual Task<string> GetMainValuePathAsync(DataSourceRowType rowType)

Parameters

Type	Name	Description
DataSourceRowType	rowType

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetRootSummaryResults()

Declaration

public virtual IgbDataGridSummaryResult[] GetRootSummaryResults()

Returns

Type	Description
IgbDataGridSummaryResult[]

GetRootSummaryResultsAsync()

Gets the summary results for the root level.

Declaration

public virtual Task<IgbDataGridSummaryResult[]> GetRootSummaryResultsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbDataGridSummaryResult[]>

GetRootSummaryRowCount()

Declaration

public virtual int GetRootSummaryRowCount()

Returns

Type	Description
System.Int32

GetRootSummaryRowCountAsync()

Gets the number of summary rows at the root level.

Declaration

public virtual Task<int> GetRootSummaryRowCountAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

GetRowCount()

Declaration

public virtual int GetRowCount()

Returns

Type	Description
System.Int32

GetRowCountAsync()

Gets the current actual full count of the items in the data source.

Declaration

public virtual Task<int> GetRowCountAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

GetRowLevel(Int32)

Declaration

public virtual int GetRowLevel(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex

Returns

Type	Description
System.Int32

GetRowLevelAsync(Int32)

Gets the hierarchy level of the row.

Declaration

public virtual Task<int> GetRowLevelAsync(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	The row to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

GetRowType(Int32)

Declaration

public virtual DataSourceRowType GetRowType(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex

Returns

Type	Description
DataSourceRowType

GetRowTypeAsync(Int32)

Declaration

public virtual Task<DataSourceRowType> GetRowTypeAsync(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex

Returns

Type	Description
System.Threading.Tasks.Task<DataSourceRowType>

GetSectionSummaryResults(Int32)

Declaration

public virtual IgbDataGridSummaryResult[][] GetSectionSummaryResults(int sectionIndex)

Parameters

Type	Name	Description
System.Int32	sectionIndex

Returns

Type	Description
IgbDataGridSummaryResult[][]

GetSectionSummaryResultsAsync(Int32)

Gets the summary results for a specific section.

Declaration

public virtual Task<IgbDataGridSummaryResult[][]> GetSectionSummaryResultsAsync(int sectionIndex)

Parameters

Type	Name	Description
System.Int32	sectionIndex

Returns

Type	Description
System.Threading.Tasks.Task<IgbDataGridSummaryResult[][]>

GetStickyRowPriority(Int32)

Declaration

public virtual int GetStickyRowPriority(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Int32

GetStickyRowPriorityAsync(Int32)

Declaration

public virtual Task<int> GetStickyRowPriorityAsync(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

GetTransactionErrorByID(Int32)

Declaration

public string GetTransactionErrorByID(int transactionID)

Parameters

Type	Name	Description
System.Int32	transactionID

Returns

Type	Description
System.String

GetTransactionErrorByIDAsync(Int32)

Returns an error, if any, associated with a specific transaction.

Declaration

public Task<string> GetTransactionErrorByIDAsync(int transactionID)

Parameters

Type	Name	Description
System.Int32	transactionID	The pending transaction ID.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetTransactionErrorByKey(Object[], String)

Declaration

public string GetTransactionErrorByKey(object[] key, string propertyPath)

Parameters

Type	Name	Description
System.Object[]	key
System.String	propertyPath

Returns

Type	Description
System.String

GetTransactionErrorByKeyAsync(Object[], String)

Declaration

public Task<string> GetTransactionErrorByKeyAsync(object[] key, string propertyPath)

Parameters

Type	Name	Description
System.Object[]	key
System.String	propertyPath

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetTransactionID(Object[], String)

Declaration

public int GetTransactionID(object[] key, string propertyPath)

Parameters

Type	Name	Description
System.Object[]	key
System.String	propertyPath

Returns

Type	Description
System.Int32

GetTransactionIDAsync(Object[], String)

Declaration

public Task<int> GetTransactionIDAsync(object[] key, string propertyPath)

Parameters

Type	Name	Description
System.Object[]	key
System.String	propertyPath

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

HasAdd(Object)

Declaration

public bool HasAdd(object item)

Parameters

Type	Name	Description
System.Object	item

Returns

Type	Description
System.Boolean

HasAddAsync(Object)

Returns whether the item is an uncommitted add.

Declaration

public Task<bool> HasAddAsync(object item)

Parameters

Type	Name	Description
System.Object	item	The item to check

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

HasDelete(Object[])

Declaration

public bool HasDelete(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Boolean

HasDeleteAsync(Object[])

Declaration

public Task<bool> HasDeleteAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

HasEdit(Object[], String)

Declaration

public bool HasEdit(object[] key, string propertyPath)

Parameters

Type	Name	Description
System.Object[]	key
System.String	propertyPath

Returns

Type	Description
System.Boolean

HasEditAsync(Object[], String)

Declaration

public Task<bool> HasEditAsync(object[] key, string propertyPath)

Parameters

Type	Name	Description
System.Object[]	key
System.String	propertyPath

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IndexOfItem(Object)

Declaration

public virtual int IndexOfItem(object item)

Parameters

Type	Name	Description
System.Object	item

Returns

Type	Description
System.Int32

IndexOfItemAsync(Object)

Called to return the index for an item contained in the data source, or -1, if the item can't be found, or this action isn't currently supported.

Declaration

public virtual Task<int> IndexOfItemAsync(object item)

Parameters

Type	Name	Description
System.Object	item	The item for which to find the index.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

IndexOfKey(Object[])

Declaration

public virtual int IndexOfKey(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Int32

IndexOfKeyAsync(Object[])

Declaration

public virtual Task<int> IndexOfKeyAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

IsExclusivelySticky(Int32)

Declaration

public virtual bool IsExclusivelySticky(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Boolean

IsExclusivelyStickyAsync(Int32)

Declaration

public virtual Task<bool> IsExclusivelyStickyAsync(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsPendingCommit(Int32)

Declaration

public bool IsPendingCommit(int commitID)

Parameters

Type	Name	Description
System.Int32	commitID

Returns

Type	Description
System.Boolean

IsPendingCommitAsync(Int32)

Returns whether a commit is pending or not.

Declaration

public Task<bool> IsPendingCommitAsync(int commitID)

Parameters

Type	Name	Description
System.Int32	commitID

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsPendingTransaction(Int32)

Declaration

public bool IsPendingTransaction(int transactionID)

Parameters

Type	Name	Description
System.Int32	transactionID

Returns

Type	Description
System.Boolean

IsPendingTransactionAsync(Int32)

Returns whether a transaction pending or not.

Declaration

public Task<bool> IsPendingTransactionAsync(int transactionID)

Parameters

Type	Name	Description
System.Int32	transactionID

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsPlaceholderItem(Int32)

Declaration

public virtual bool IsPlaceholderItem(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Boolean

IsPlaceholderItemAsync(Int32)

Returns true if the item at the requested index is a placeholder item and has not been actualized.

Declaration

public virtual Task<bool> IsPlaceholderItemAsync(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsRowPinned(Int32)

Declaration

public virtual bool IsRowPinned(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Boolean

IsRowPinnedAsync(Int32)

Declaration

public virtual Task<bool> IsRowPinnedAsync(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsRowSpanning(DataSourceRowType)

Declaration

public virtual bool IsRowSpanning(DataSourceRowType rowType)

Parameters

Type	Name	Description
DataSourceRowType	rowType

Returns

Type	Description
System.Boolean

IsRowSpanningAsync(DataSourceRowType)

Declaration

public virtual Task<bool> IsRowSpanningAsync(DataSourceRowType rowType)

Parameters

Type	Name	Description
DataSourceRowType	rowType

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

NotifyClearItems()

Declaration

public void NotifyClearItems()

NotifyClearItemsAsync()

Manually notifies the data source that the data it has bound to has been cleared and needs to be re-examined. This should not be necessary to call if the data that the data source is bound to is already observable.

Declaration

public Task NotifyClearItemsAsync()

Returns

Type	Description
System.Threading.Tasks.Task

NotifyInsertItem(Int32, Object)

Declaration

public void NotifyInsertItem(int index, object newItem)

Parameters

Type	Name	Description
System.Int32	index
System.Object	newItem

NotifyInsertItemAsync(Int32, Object)

Declaration

public Task NotifyInsertItemAsync(int index, object newItem)

Parameters

Type	Name	Description
System.Int32	index
System.Object	newItem

Returns

Type	Description
System.Threading.Tasks.Task

NotifyRemoveItem(Int32, Object)

Declaration

public void NotifyRemoveItem(int index, object oldItem)

Parameters

Type	Name	Description
System.Int32	index
System.Object	oldItem

NotifyRemoveItemAsync(Int32, Object)

Declaration

public Task NotifyRemoveItemAsync(int index, object oldItem)

Parameters

Type	Name	Description
System.Int32	index
System.Object	oldItem

Returns

Type	Description
System.Threading.Tasks.Task

NotifySetItem(Int32, Object, Object)

Declaration

public void NotifySetItem(int index, object oldItem, object newItem)

Parameters

Type	Name	Description
System.Int32	index
System.Object	oldItem
System.Object	newItem

NotifySetItemAsync(Int32, Object, Object)

Declaration

public Task NotifySetItemAsync(int index, object oldItem, object newItem)

Parameters

Type	Name	Description
System.Int32	index
System.Object	oldItem
System.Object	newItem

Returns

Type	Description
System.Threading.Tasks.Task

PinRow(Object[])

Declaration

public virtual void PinRow(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

PinRowAsync(Object[])

Declaration

public virtual Task PinRowAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task

QueueAutoRefresh()

Declaration

public void QueueAutoRefresh()

QueueAutoRefreshAsync()

Called to manually queue a refresh of the data source.

Declaration

public Task QueueAutoRefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Redo()

Declaration

public void Redo()

RedoAsync()

Redo the last undo.

Declaration

public Task RedoAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Refresh()

Declaration

public void Refresh()

RefreshAsync()

Called to synchronously refresh the data source.

Declaration

public Task RefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

RejectPendingCommit(Int32)

Declaration

public void RejectPendingCommit(int commitID)

Parameters

Type	Name	Description
System.Int32	commitID

RejectPendingCommitAsync(Int32)

Cancel a commit with the provided ID.

Declaration

public Task RejectPendingCommitAsync(int commitID)

Parameters

Type	Name	Description
System.Int32	commitID	The ID of the commit to reject.

Returns

Type	Description
System.Threading.Tasks.Task

RejectPendingTransaction(Int32)

Declaration

public void RejectPendingTransaction(int transactionID)

Parameters

Type	Name	Description
System.Int32	transactionID

RejectPendingTransactionAsync(Int32)

Rejects a pending transaction.

Declaration

public Task RejectPendingTransactionAsync(int transactionID)

Parameters

Type	Name	Description
System.Int32	transactionID	The transactions unique ID.

Returns

Type	Description
System.Threading.Tasks.Task

RemoveItem(Object)

Declaration

public void RemoveItem(object item)

Parameters

Type	Name	Description
System.Object	item

RemoveItemAsync(Object)

Removes an item from the datasource.

Declaration

public Task RemoveItemAsync(object item)

Parameters

Type	Name	Description
System.Object	item	The item to remove.

Returns

Type	Description
System.Threading.Tasks.Task

RemoveItemByKey(Object[])

Declaration

public virtual void RemoveItemByKey(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

RemoveItemByKeyAsync(Object[])

Declaration

public virtual Task RemoveItemByKeyAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task

ResolveSchemaPropertyType(String)

Declaration

public virtual DataSourceSchemaPropertyType ResolveSchemaPropertyType(string propertyPath)

Parameters

Type	Name	Description
System.String	propertyPath

Returns

Type	Description
DataSourceSchemaPropertyType

ResolveSchemaPropertyTypeAsync(String)

Resolve a property or property path to its value type.

Declaration

public virtual Task<DataSourceSchemaPropertyType> ResolveSchemaPropertyTypeAsync(string propertyPath)

Parameters

Type	Name	Description
System.String	propertyPath	The property or property path.

Returns

Type	Description
System.Threading.Tasks.Task<DataSourceSchemaPropertyType>

SetCustomizedStringAsync(String, String)

Provide a new set of localized strings to use for a given languange.

Declaration

public Task<object> SetCustomizedStringAsync(string language, string json)

Parameters

Type	Name	Description
System.String	language	The browser language the strings will be used with. I.e. "ja", "en", "fr", etc.
System.String	json	The new string values in json format.

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

SetCustomizedStringAsync(String, String, String)

Provide a new set of localized strings to use for a given languange.

Declaration

public Task<object> SetCustomizedStringAsync(string language, string id, string value)

Parameters

Type	Name	Description
System.String	language	The browser language the strings will be used with. I.e. "ja", "en", "fr", etc.
System.String	id	The id of the string to set.
System.String	value	The new string value.

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

SetIsRowExpandedAtIndex(Int32, Boolean)

Declaration

public virtual void SetIsRowExpandedAtIndex(int rowIndex, bool isExpanded)

Parameters

Type	Name	Description
System.Int32	rowIndex
System.Boolean	isExpanded

SetIsRowExpandedAtIndexAsync(Int32, Boolean)

Declaration

public virtual Task SetIsRowExpandedAtIndexAsync(int rowIndex, bool isExpanded)

Parameters

Type	Name	Description
System.Int32	rowIndex
System.Boolean	isExpanded

Returns

Type	Description
System.Threading.Tasks.Task

SetTransactionError(Int32, String)

Declaration

public void SetTransactionError(int transactionID, string message)

Parameters

Type	Name	Description
System.Int32	transactionID
System.String	message

SetTransactionErrorAsync(Int32, String)

Declaration

public Task SetTransactionErrorAsync(int transactionID, string message)

Parameters

Type	Name	Description
System.Int32	transactionID
System.String	message

Returns

Type	Description
System.Threading.Tasks.Task

Undo()

Declaration

public void Undo()

UndoAsync()

Undo the last edit.

Declaration

public Task UndoAsync()

Returns

Type	Description
System.Threading.Tasks.Task

UnpinRow(Object[])

Declaration

public virtual void UnpinRow(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

UnpinRowAsync(Object[])

Declaration

public virtual Task UnpinRowAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task

UpdatePropertyAtKey(Object[], String, Object, Boolean)

Declaration

public virtual int UpdatePropertyAtKey(object[] key, string propertyPath, object value, bool isPending = false)

Parameters

Type	Name	Description
System.Object[]	key
System.String	propertyPath
System.Object	value
System.Boolean	isPending

Returns

Type	Description
System.Int32

UpdatePropertyAtKeyAsync(Object[], String, Object, Boolean)

Declaration

public virtual Task<int> UpdatePropertyAtKeyAsync(object[] key, string propertyPath, object value, bool isPending = false)

Parameters

Type	Name	Description
System.Object[]	key
System.String	propertyPath
System.Object	value
System.Boolean	isPending

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

Implements

JsonSerializable