Provides a base implementation of IDataSource that data source implementations can further extend.
Inheritance
object
ComponentBase
Classes that extend this class.
Derived Classes Implements
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
Constructors
Section titled "Constructors"constructor
public IgbBaseDataSource()Returns IgbBaseDataSource
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererElement
protected virtual string ParentTypeName { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererElement
protected virtual bool UseDirectRender { get; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererElement
[Parameter]
public RenderFragment ChildContent { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererElement
protected virtual bool SupportsVisualChildren { get; }Inherited from: BaseRendererElement
[Parameter]
public string Name { get; set; }Parent
Section titled "Parent"Inherited from: BaseRendererElement
public object Parent { get; }MethodTarget
Section titled "MethodTarget"Inherited from: BaseRendererElement
protected virtual string MethodTarget { get; }CurrParent
Section titled "CurrParent"Inherited from: BaseRendererElement
protected object CurrParent { get; }ActualCount
Section titled "ActualCount"Gets the current actual full count of the items in the data source.
[Parameter]
public int ActualCount { get; set; }DeferAutoRefresh
Section titled "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.
[Parameter]
public bool DeferAutoRefresh { get; set; }FirstVisibleIndexRequested
Section titled "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.
[Parameter]
public int FirstVisibleIndexRequested { get; set; }IncludeSummaryRowsInSection
Section titled "IncludeSummaryRowsInSection"Gets or sets whether the data source should include summary rows inside the group when summaries are present.
[Parameter]
public virtual bool IncludeSummaryRowsInSection { get; set; }IsBatchingEnabled
Section titled "IsBatchingEnabled"Gets or sets whether batch edits are enabled.
[Parameter]
public virtual bool IsBatchingEnabled { get; set; }IsReadOnly
Section titled "IsReadOnly"Gets or sets whether the data source is read-only or not.
[Parameter]
public bool IsReadOnly { get; set; }IsSectionCollapsable
Section titled "IsSectionCollapsable"Gets or sets if sections are collapsable.
[Parameter]
public virtual bool IsSectionCollapsable { get; set; }IsSectionContentVisible
Section titled "IsSectionContentVisible"Gets or sets whether content besides the section headers are displayed.
[Parameter]
public virtual bool IsSectionContentVisible { get; set; }IsSectionExpandedDefault
Section titled "IsSectionExpandedDefault"Gets or sets whether sections default to expanded or collapsed when they are created.
[Parameter]
public virtual bool IsSectionExpandedDefault { get; set; }IsSectionHeaderNormalRow
Section titled "IsSectionHeaderNormalRow"Gets or sets whether the section headers are treated as normal rows.
[Parameter]
public virtual bool IsSectionHeaderNormalRow { get; set; }IsSectionSummaryRowsAtBottom
Section titled "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.
[Parameter]
public virtual bool IsSectionSummaryRowsAtBottom { get; set; }LastVisibleIndexRequested
Section titled "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.
[Parameter]
public int LastVisibleIndexRequested { get; set; }PrimaryKey
Section titled "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.
[Parameter]
public string[] PrimaryKey { get; set; }PropertiesRequested
Section titled "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.
[Parameter]
public string[] PropertiesRequested { get; set; }SchemaIncludedProperties
Section titled "SchemaIncludedProperties"Gets or sets what properties should be included when resolving the datasource schema. If null, all properties are included.
[Parameter]
public string[] SchemaIncludedProperties { get; set; }SectionHeaderDisplayMode
Section titled "SectionHeaderDisplayMode"Gets or sets how section headers are displayed.
[Parameter]
public virtual DataSourceSectionHeaderDisplayMode SectionHeaderDisplayMode { get; set; }ShouldEmitSectionFooters
Section titled "ShouldEmitSectionFooters"[Parameter]
public bool ShouldEmitSectionFooters { get; set; }ShouldEmitSectionHeaders
Section titled "ShouldEmitSectionHeaders"[Parameter]
public bool ShouldEmitSectionHeaders { get; set; }ShouldEmitShiftedRows
Section titled "ShouldEmitShiftedRows"[Parameter]
public bool ShouldEmitShiftedRows { get; set; }ShouldEmitSummaryRows
Section titled "ShouldEmitSummaryRows"[Parameter]
public bool ShouldEmitSummaryRows { get; set; }public override string Type { get; }Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _nameeventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContentMethods
Section titled "Methods"EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"Inherited from: BaseRendererElement
protected virtual void EnsureModulesLoaded()Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererElement
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererElement
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelper(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererElement
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererElement
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererElement
public string Serialize()Returns any
EnsureValid()
Section titled "EnsureValid()"Inherited from: BaseRendererElement
protected void EnsureValid()Returns any
FromEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
ToEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
AcceptPendingCommit(int)
Section titled "AcceptPendingCommit(int)"public void AcceptPendingCommit(int commitID)Parameters
- commitID:
int
Returns any
AcceptPendingCommitAsync(int)
Section titled "AcceptPendingCommitAsync(int)"Accepts a commit with the provided ID.
public Task AcceptPendingCommitAsync(int commitID)Parameters
- commitID:
int
Returns any
AcceptPendingTransaction(int)
Section titled "AcceptPendingTransaction(int)"public void AcceptPendingTransaction(int transactionID)Parameters
- transactionID:
int
Returns any
AcceptPendingTransactionAsync(int)
Section titled "AcceptPendingTransactionAsync(int)"Save a specific pending transaction.
public Task AcceptPendingTransactionAsync(int transactionID)Parameters
- transactionID:
int
Returns any
AddItem(object)
Section titled "AddItem(object)"public void AddItem(object item)Parameters
- item:
object
Returns any
AddItemAsync(object)
Section titled "AddItemAsync(object)"public Task AddItemAsync(object item)Parameters
- item:
object
Returns any
CancelEdits()
Section titled "CancelEdits()"public void CancelEdits()Returns any
CancelEditsAsync()
Section titled "CancelEditsAsync()"Cancels any batched edits that may exist.
public Task CancelEditsAsync()Returns any
ClearPinnedRows()
Section titled "ClearPinnedRows()"public virtual void ClearPinnedRows()Returns any
ClearPinnedRowsAsync()
Section titled "ClearPinnedRowsAsync()"public virtual Task ClearPinnedRowsAsync()Returns any
Clone()
Section titled "Clone()"public virtual DataSource Clone()Returns any
CloneAsync()
Section titled "CloneAsync()"Clones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance.
public virtual Task<DataSource> CloneAsync()Returns any
CloneProperties(DataSource)
Section titled "CloneProperties(DataSource)"public virtual void CloneProperties(DataSource dataSource)Parameters
- dataSource:
DataSource
Returns any
ClonePropertiesAsync(DataSource)
Section titled "ClonePropertiesAsync(DataSource)"Clones the properties over to the provided datasource.
public virtual Task ClonePropertiesAsync(DataSource dataSource)Parameters
- dataSource:
DataSource
Returns any
CommitEdits(bool)
Section titled "CommitEdits(bool)"public int CommitEdits(bool isPending)Parameters
- isPending:
bool
Returns any
CommitEditsAsync(bool)
Section titled "CommitEditsAsync(bool)"Commit the current edits to the datasource.
public Task<int> CommitEditsAsync(bool isPending)Parameters
- isPending:
bool
Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
FlushAutoRefresh()
Section titled "FlushAutoRefresh()"public void FlushAutoRefresh()Returns any
FlushAutoRefreshAsync()
Section titled "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
public Task FlushAutoRefreshAsync()Returns any
GetAggregatedChanges(int)
Section titled "GetAggregatedChanges(int)"public IgbDataSourceAggregatedResult[] GetAggregatedChanges(int commitID)Parameters
- commitID:
int
Returns any
GetAggregatedChangesAsync(int)
Section titled "GetAggregatedChangesAsync(int)"Returns a set of changes that have been made to the data however have not been committed yet.
public Task<IgbDataSourceAggregatedResult[]> GetAggregatedChangesAsync(int commitID)Parameters
- commitID:
int
Returns any
GetIsRowExpandedAtIndex(int)
Section titled "GetIsRowExpandedAtIndex(int)"public virtual bool GetIsRowExpandedAtIndex(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetIsRowExpandedAtIndexAsync(int)
Section titled "GetIsRowExpandedAtIndexAsync(int)"Gets the expansion state for a row.
public virtual Task<bool> GetIsRowExpandedAtIndexAsync(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetItemAtIndex(int)
Section titled "GetItemAtIndex(int)"public virtual object GetItemAtIndex(int index)Parameters
- index:
int
Returns any
GetItemAtIndexAsync(int)
Section titled "GetItemAtIndexAsync(int)"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.
public virtual Task<object> GetItemAtIndexAsync(int index)Parameters
- index:
int
Returns any
GetItemFromKey(object[])
Section titled "GetItemFromKey(object[])"public virtual object GetItemFromKey(object[] key)Parameters
- key:
object[]
Returns any
GetItemFromKeyAsync(object[])
Section titled "GetItemFromKeyAsync(object[])"public virtual Task<object> GetItemFromKeyAsync(object[] key)Parameters
- key:
object[]
Returns any
GetItemProperty(object, string)
Section titled "GetItemProperty(object, string)"public virtual object GetItemProperty(object item, string propertyName)Parameters
- item:
object - propertyName:
string
Returns any
GetItemPropertyAsync(object, string)
Section titled "GetItemPropertyAsync(object, string)"public virtual Task<object> GetItemPropertyAsync(object item, string propertyName)Parameters
- item:
object - propertyName:
string
Returns any
GetItemPropertyAtIndex(int, string)
Section titled "GetItemPropertyAtIndex(int, string)"public virtual object GetItemPropertyAtIndex(int index, string valueName)Parameters
- index:
int - valueName:
string
Returns any
GetItemPropertyAtIndexAsync(int, string)
Section titled "GetItemPropertyAtIndexAsync(int, string)"public virtual Task<object> GetItemPropertyAtIndexAsync(int index, string valueName)Parameters
- index:
int - valueName:
string
Returns any
GetMainValuePath(DataSourceRowType)
Section titled "GetMainValuePath(DataSourceRowType)"public virtual string GetMainValuePath(DataSourceRowType rowType)Parameters
- rowType:
DataSourceRowType
Returns any
GetMainValuePathAsync(DataSourceRowType)
Section titled "GetMainValuePathAsync(DataSourceRowType)"public virtual Task<string> GetMainValuePathAsync(DataSourceRowType rowType)Parameters
- rowType:
DataSourceRowType
Returns any
GetRootSummaryResults()
Section titled "GetRootSummaryResults()"public virtual IgbDataGridSummaryResult[] GetRootSummaryResults()Returns any
GetRootSummaryResultsAsync()
Section titled "GetRootSummaryResultsAsync()"Gets the summary results for the root level.
public virtual Task<IgbDataGridSummaryResult[]> GetRootSummaryResultsAsync()Returns any
GetRootSummaryRowCount()
Section titled "GetRootSummaryRowCount()"public virtual int GetRootSummaryRowCount()Returns any
GetRootSummaryRowCountAsync()
Section titled "GetRootSummaryRowCountAsync()"Gets the number of summary rows at the root level.
public virtual Task<int> GetRootSummaryRowCountAsync()Returns any
GetRowCount()
Section titled "GetRowCount()"public virtual int GetRowCount()Returns any
GetRowCountAsync()
Section titled "GetRowCountAsync()"Gets the current actual full count of the items in the data source.
public virtual Task<int> GetRowCountAsync()Returns any
GetRowLevel(int)
Section titled "GetRowLevel(int)"public virtual int GetRowLevel(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetRowLevelAsync(int)
Section titled "GetRowLevelAsync(int)"Gets the hierarchy level of the row.
public virtual Task<int> GetRowLevelAsync(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetRowType(int)
Section titled "GetRowType(int)"public virtual DataSourceRowType GetRowType(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetRowTypeAsync(int)
Section titled "GetRowTypeAsync(int)"public virtual Task<DataSourceRowType> GetRowTypeAsync(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetSectionSummaryResults(int)
Section titled "GetSectionSummaryResults(int)"public virtual IgbDataGridSummaryResult[][] GetSectionSummaryResults(int sectionIndex)Parameters
- sectionIndex:
int
Returns any
GetSectionSummaryResultsAsync(int)
Section titled "GetSectionSummaryResultsAsync(int)"Gets the summary results for a specific section.
public virtual Task<IgbDataGridSummaryResult[][]> GetSectionSummaryResultsAsync(int sectionIndex)Parameters
- sectionIndex:
int
Returns any
GetStickyRowPriority(int)
Section titled "GetStickyRowPriority(int)"public virtual int GetStickyRowPriority(int row)Parameters
- row:
int
Returns any
GetStickyRowPriorityAsync(int)
Section titled "GetStickyRowPriorityAsync(int)"public virtual Task<int> GetStickyRowPriorityAsync(int row)Parameters
- row:
int
Returns any
GetTransactionErrorByID(int)
Section titled "GetTransactionErrorByID(int)"public string GetTransactionErrorByID(int transactionID)Parameters
- transactionID:
int
Returns any
GetTransactionErrorByIDAsync(int)
Section titled "GetTransactionErrorByIDAsync(int)"Returns an error, if any, associated with a specific transaction.
public Task<string> GetTransactionErrorByIDAsync(int transactionID)Parameters
- transactionID:
int
Returns any
GetTransactionErrorByKey(object[], string)
Section titled "GetTransactionErrorByKey(object[], string)"public string GetTransactionErrorByKey(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
GetTransactionErrorByKeyAsync(object[], string)
Section titled "GetTransactionErrorByKeyAsync(object[], string)"public Task<string> GetTransactionErrorByKeyAsync(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
GetTransactionID(object[], string)
Section titled "GetTransactionID(object[], string)"public int GetTransactionID(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
GetTransactionIDAsync(object[], string)
Section titled "GetTransactionIDAsync(object[], string)"public Task<int> GetTransactionIDAsync(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
HasAdd(object)
Section titled "HasAdd(object)"public bool HasAdd(object item)Parameters
- item:
object
Returns any
HasAddAsync(object)
Section titled "HasAddAsync(object)"Returns whether the item is an uncommitted add.
public Task<bool> HasAddAsync(object item)Parameters
- item:
object
Returns any
HasDelete(object[])
Section titled "HasDelete(object[])"public bool HasDelete(object[] key)Parameters
- key:
object[]
Returns any
HasDeleteAsync(object[])
Section titled "HasDeleteAsync(object[])"public Task<bool> HasDeleteAsync(object[] key)Parameters
- key:
object[]
Returns any
HasEdit(object[], string)
Section titled "HasEdit(object[], string)"public bool HasEdit(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
HasEditAsync(object[], string)
Section titled "HasEditAsync(object[], string)"public Task<bool> HasEditAsync(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
IndexOfItem(object)
Section titled "IndexOfItem(object)"public virtual int IndexOfItem(object item)Parameters
- item:
object
Returns any
IndexOfItemAsync(object)
Section titled "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.
public virtual Task<int> IndexOfItemAsync(object item)Parameters
- item:
object
Returns any
IndexOfKey(object[])
Section titled "IndexOfKey(object[])"public virtual int IndexOfKey(object[] key)Parameters
- key:
object[]
Returns any
IndexOfKeyAsync(object[])
Section titled "IndexOfKeyAsync(object[])"public virtual Task<int> IndexOfKeyAsync(object[] key)Parameters
- key:
object[]
Returns any
IsExclusivelySticky(int)
Section titled "IsExclusivelySticky(int)"public virtual bool IsExclusivelySticky(int row)Parameters
- row:
int
Returns any
IsExclusivelyStickyAsync(int)
Section titled "IsExclusivelyStickyAsync(int)"public virtual Task<bool> IsExclusivelyStickyAsync(int row)Parameters
- row:
int
Returns any
IsPendingCommit(int)
Section titled "IsPendingCommit(int)"public bool IsPendingCommit(int commitID)Parameters
- commitID:
int
Returns any
IsPendingCommitAsync(int)
Section titled "IsPendingCommitAsync(int)"Returns whether a commit is pending or not.
public Task<bool> IsPendingCommitAsync(int commitID)Parameters
- commitID:
int
Returns any
IsPendingTransaction(int)
Section titled "IsPendingTransaction(int)"public bool IsPendingTransaction(int transactionID)Parameters
- transactionID:
int
Returns any
IsPendingTransactionAsync(int)
Section titled "IsPendingTransactionAsync(int)"Returns whether a transaction pending or not.
public Task<bool> IsPendingTransactionAsync(int transactionID)Parameters
- transactionID:
int
Returns any
IsPlaceholderItem(int)
Section titled "IsPlaceholderItem(int)"public virtual bool IsPlaceholderItem(int index)Parameters
- index:
int
Returns any
IsPlaceholderItemAsync(int)
Section titled "IsPlaceholderItemAsync(int)"Returns true if the item at the requested index is a placeholder item and has not been actualized.
public virtual Task<bool> IsPlaceholderItemAsync(int index)Parameters
- index:
int
Returns any
IsRowPinned(int)
Section titled "IsRowPinned(int)"public virtual bool IsRowPinned(int row)Parameters
- row:
int
Returns any
IsRowPinnedAsync(int)
Section titled "IsRowPinnedAsync(int)"public virtual Task<bool> IsRowPinnedAsync(int row)Parameters
- row:
int
Returns any
IsRowSpanning(DataSourceRowType)
Section titled "IsRowSpanning(DataSourceRowType)"public virtual bool IsRowSpanning(DataSourceRowType rowType)Parameters
- rowType:
DataSourceRowType
Returns any
IsRowSpanningAsync(DataSourceRowType)
Section titled "IsRowSpanningAsync(DataSourceRowType)"public virtual Task<bool> IsRowSpanningAsync(DataSourceRowType rowType)Parameters
- rowType:
DataSourceRowType
Returns any
NotifyClearItems()
Section titled "NotifyClearItems()"public void NotifyClearItems()Returns any
NotifyClearItemsAsync()
Section titled "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.
public Task NotifyClearItemsAsync()Returns any
NotifyInsertItem(int, object)
Section titled "NotifyInsertItem(int, object)"public void NotifyInsertItem(int index, object newItem)Parameters
- index:
int - newItem:
object
Returns any
NotifyInsertItemAsync(int, object)
Section titled "NotifyInsertItemAsync(int, object)"public Task NotifyInsertItemAsync(int index, object newItem)Parameters
- index:
int - newItem:
object
Returns any
NotifyRemoveItem(int, object)
Section titled "NotifyRemoveItem(int, object)"public void NotifyRemoveItem(int index, object oldItem)Parameters
- index:
int - oldItem:
object
Returns any
NotifyRemoveItemAsync(int, object)
Section titled "NotifyRemoveItemAsync(int, object)"public Task NotifyRemoveItemAsync(int index, object oldItem)Parameters
- index:
int - oldItem:
object
Returns any
NotifySetItem(int, object, object)
Section titled "NotifySetItem(int, object, object)"public void NotifySetItem(int index, object oldItem, object newItem)Parameters
- index:
int - oldItem:
object - newItem:
object
Returns any
NotifySetItemAsync(int, object, object)
Section titled "NotifySetItemAsync(int, object, object)"public Task NotifySetItemAsync(int index, object oldItem, object newItem)Parameters
- index:
int - oldItem:
object - newItem:
object
Returns any
PinRow(object[])
Section titled "PinRow(object[])"public virtual void PinRow(object[] key)Parameters
- key:
object[]
Returns any
PinRowAsync(object[])
Section titled "PinRowAsync(object[])"public virtual Task PinRowAsync(object[] key)Parameters
- key:
object[]
Returns any
QueueAutoRefresh()
Section titled "QueueAutoRefresh()"public void QueueAutoRefresh()Returns any
QueueAutoRefreshAsync()
Section titled "QueueAutoRefreshAsync()"Called to manually queue a refresh of the data source.
public Task QueueAutoRefreshAsync()Returns any
Redo()
Section titled "Redo()"public void Redo()Returns any
RedoAsync()
Section titled "RedoAsync()"Redo the last undo.
public Task RedoAsync()Returns any
Refresh()
Section titled "Refresh()"public void Refresh()Returns any
RefreshAsync()
Section titled "RefreshAsync()"Called to synchronously refresh the data source.
public Task RefreshAsync()Returns any
RejectPendingCommit(int)
Section titled "RejectPendingCommit(int)"public void RejectPendingCommit(int commitID)Parameters
- commitID:
int
Returns any
RejectPendingCommitAsync(int)
Section titled "RejectPendingCommitAsync(int)"Cancel a commit with the provided ID.
public Task RejectPendingCommitAsync(int commitID)Parameters
- commitID:
int
Returns any
RejectPendingTransaction(int)
Section titled "RejectPendingTransaction(int)"public void RejectPendingTransaction(int transactionID)Parameters
- transactionID:
int
Returns any
RejectPendingTransactionAsync(int)
Section titled "RejectPendingTransactionAsync(int)"Rejects a pending transaction.
public Task RejectPendingTransactionAsync(int transactionID)Parameters
- transactionID:
int
Returns any
RemoveItem(object)
Section titled "RemoveItem(object)"public void RemoveItem(object item)Parameters
- item:
object
Returns any
RemoveItemAsync(object)
Section titled "RemoveItemAsync(object)"Removes an item from the datasource.
public Task RemoveItemAsync(object item)Parameters
- item:
object
Returns any
RemoveItemByKey(object[])
Section titled "RemoveItemByKey(object[])"public virtual void RemoveItemByKey(object[] key)Parameters
- key:
object[]
Returns any
RemoveItemByKeyAsync(object[])
Section titled "RemoveItemByKeyAsync(object[])"public virtual Task RemoveItemByKeyAsync(object[] key)Parameters
- key:
object[]
Returns any
ResolveSchemaPropertyType(string)
Section titled "ResolveSchemaPropertyType(string)"public virtual DataSourceSchemaPropertyType ResolveSchemaPropertyType(string propertyPath)Parameters
- propertyPath:
string
Returns any
ResolveSchemaPropertyTypeAsync(string)
Section titled "ResolveSchemaPropertyTypeAsync(string)"Resolve a property or property path to its value type.
public virtual Task<DataSourceSchemaPropertyType> ResolveSchemaPropertyTypeAsync(string propertyPath)Parameters
- propertyPath:
string
Returns any
SetCustomizedStringAsync(string, string)
Section titled "SetCustomizedStringAsync(string, string)"Provide a new set of localized strings to use for a given languange.
public Task<object> SetCustomizedStringAsync(string language, string json)Parameters
- language:
string - json:
string
Returns any
SetCustomizedStringAsync(string, string, string)
Section titled "SetCustomizedStringAsync(string, string, string)"Provide a new set of localized strings to use for a given languange.
public Task<object> SetCustomizedStringAsync(string language, string id, string value)Parameters
- language:
string - id:
string - value:
string
Returns any
SetIsRowExpandedAtIndex(int, bool)
Section titled "SetIsRowExpandedAtIndex(int, bool)"public virtual void SetIsRowExpandedAtIndex(int rowIndex, bool isExpanded)Parameters
- rowIndex:
int - isExpanded:
bool
Returns any
SetIsRowExpandedAtIndexAsync(int, bool)
Section titled "SetIsRowExpandedAtIndexAsync(int, bool)"public virtual Task SetIsRowExpandedAtIndexAsync(int rowIndex, bool isExpanded)Parameters
- rowIndex:
int - isExpanded:
bool
Returns any
SetTransactionError(int, string)
Section titled "SetTransactionError(int, string)"public void SetTransactionError(int transactionID, string message)Parameters
- transactionID:
int - message:
string
Returns any
SetTransactionErrorAsync(int, string)
Section titled "SetTransactionErrorAsync(int, string)"public Task SetTransactionErrorAsync(int transactionID, string message)Parameters
- transactionID:
int - message:
string
Returns any
Undo()
Section titled "Undo()"public void Undo()Returns any
UndoAsync()
Section titled "UndoAsync()"Undo the last edit.
public Task UndoAsync()Returns any
UnpinRow(object[])
Section titled "UnpinRow(object[])"public virtual void UnpinRow(object[] key)Parameters
- key:
object[]
Returns any
UnpinRowAsync(object[])
Section titled "UnpinRowAsync(object[])"public virtual Task UnpinRowAsync(object[] key)Parameters
- key:
object[]
Returns any
UpdatePropertyAtKey(object[], string, object, bool)
Section titled "UpdatePropertyAtKey(object[], string, object, bool)"public virtual int UpdatePropertyAtKey(object[] key, string propertyPath, object value, bool isPending = false)Parameters
- key:
object[] - propertyPath:
string - value:
object - isPending:
bool
Returns any
UpdatePropertyAtKeyAsync(object[], string, object, bool)
Section titled "UpdatePropertyAtKeyAsync(object[], string, object, bool)"public virtual Task<int> UpdatePropertyAtKeyAsync(object[] key, string propertyPath, object value, bool isPending = false)Parameters
- key:
object[] - propertyPath:
string - value:
object - isPending:
bool
Returns any
Events
Section titled "Events"PropertiesRequestedChanged
Section titled "PropertiesRequestedChanged"[Parameter]
public EventCallback<IgbDataSourcePropertiesRequestedChangedEventArgs> PropertiesRequestedChanged { get; set; }RootSummariesChanged
Section titled "RootSummariesChanged"[Parameter]
public EventCallback<IgbDataSourceRootSummariesChangedEventArgs> RootSummariesChanged { get; set; }RowExpansionChanged
Section titled "RowExpansionChanged"[Parameter]
public EventCallback<IgbDataSourceRowExpansionChangedEventArgs> RowExpansionChanged { get; set; }SchemaChanged
Section titled "SchemaChanged"[Parameter]
public EventCallback<IgbDataSourceSchemaChangedEventArgs> SchemaChanged { get; set; }PropertiesRequestedChangedScript
Section titled "PropertiesRequestedChangedScript"[Parameter]
public string PropertiesRequestedChangedScript { get; set; }RootSummariesChangedScript
Section titled "RootSummariesChangedScript"[Parameter]
public string RootSummariesChangedScript { get; set; }RowExpansionChangedScript
Section titled "RowExpansionChangedScript"[Parameter]
public string RowExpansionChangedScript { get; set; }SchemaChangedScript
Section titled "SchemaChangedScript"[Parameter]
public string SchemaChangedScript { get; set; }