A virtual data source which may not have synchronous access to all its data items, and resulting may synchronously return placeholders for items that have yet to be actualized.
Inheritance
object
ComponentBase
Classes that extend this class.
Derived Classes- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
Constructors
Section titled "Constructors"constructor
public IgbVirtualDataSource()Returns IgbVirtualDataSource
Properties
Section titled "Properties"IsReadOnly
Section titled "IsReadOnly"Inherited from: IgbBaseDataSource
Gets or sets whether the data source is read-only or not.
[Parameter]
public bool IsReadOnly { get; set; }ActualCount
Section titled "ActualCount"Inherited from: IgbBaseDataSource
Gets the current actual full count of the items in the data source.
[Parameter]
public int ActualCount { get; set; }FirstVisibleIndexRequested
Section titled "FirstVisibleIndexRequested"Inherited from: IgbBaseDataSource
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; }LastVisibleIndexRequested
Section titled "LastVisibleIndexRequested"Inherited from: IgbBaseDataSource
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; }DeferAutoRefresh
Section titled "DeferAutoRefresh"Inherited from: IgbBaseDataSource
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; }PrimaryKey
Section titled "PrimaryKey"Inherited from: IgbBaseDataSource
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"Inherited from: IgbBaseDataSource
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"Inherited from: IgbBaseDataSource
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"Inherited from: IgbBaseDataSource
Gets or sets how section headers are displayed.
[Parameter]
public virtual DataSourceSectionHeaderDisplayMode SectionHeaderDisplayMode { get; set; }IncludeSummaryRowsInSection
Section titled "IncludeSummaryRowsInSection"Inherited from: IgbBaseDataSource
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; }IsSectionSummaryRowsAtBottom
Section titled "IsSectionSummaryRowsAtBottom"Inherited from: IgbBaseDataSource
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; }IsSectionHeaderNormalRow
Section titled "IsSectionHeaderNormalRow"Inherited from: IgbBaseDataSource
Gets or sets whether the section headers are treated as normal rows.
[Parameter]
public virtual bool IsSectionHeaderNormalRow { get; set; }IsSectionContentVisible
Section titled "IsSectionContentVisible"Inherited from: IgbBaseDataSource
Gets or sets whether content besides the section headers are displayed.
[Parameter]
public virtual bool IsSectionContentVisible { get; set; }ShouldEmitSectionHeaders
Section titled "ShouldEmitSectionHeaders"Inherited from: IgbBaseDataSource
[Parameter]
public bool ShouldEmitSectionHeaders { get; set; }ShouldEmitSectionFooters
Section titled "ShouldEmitSectionFooters"Inherited from: IgbBaseDataSource
[Parameter]
public bool ShouldEmitSectionFooters { get; set; }ShouldEmitShiftedRows
Section titled "ShouldEmitShiftedRows"Inherited from: IgbBaseDataSource
[Parameter]
public bool ShouldEmitShiftedRows { get; set; }ShouldEmitSummaryRows
Section titled "ShouldEmitSummaryRows"Inherited from: IgbBaseDataSource
[Parameter]
public bool ShouldEmitSummaryRows { get; set; }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; }ActualPageSize
Section titled "ActualPageSize"Gets the actual resolved page size that will be used.
[Parameter]
public int ActualPageSize { get; set; }ConcurrencyTag
Section titled "ConcurrencyTag"Gets or sets the field to use for concurrency. I.e. for odata, RowVersion for sql, etc.
[Parameter]
public string ConcurrencyTag { get; set; }IsBatchingEnabled
Section titled "IsBatchingEnabled"Gets whether batch edits are enabled. Setting this property will have no effect.
[Parameter]
public override bool IsBatchingEnabled { get; set; }IsSectionCollapsable
Section titled "IsSectionCollapsable"Gets or sets if sections are collapsable.
[Parameter]
public override bool IsSectionCollapsable { get; set; }IsSectionExpandedDefault
Section titled "IsSectionExpandedDefault"Gets or sets whether sections default to expanded or collapsed when they are created.
[Parameter]
public override bool IsSectionExpandedDefault { get; set; }MaxCachedPages
Section titled "MaxCachedPages"Gets or sets the maximum number of data pages to cache in the data source before the oldest pages will start being evicted.
[Parameter]
public int MaxCachedPages { get; set; }PageSizeRequested
Section titled "PageSizeRequested"Gets or sets the desired page size. This may or may not be respected by the underlying provider, or its connected services.
[Parameter]
public int PageSizeRequested { 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"AddItemAsync(object)
Section titled "AddItemAsync(object)"Inherited from: IgbBaseDataSource
public Task AddItemAsync(object item)Parameters
- item:
object
Returns any
AddItem(object)
Section titled "AddItem(object)"Inherited from: IgbBaseDataSource
public void AddItem(object item)Parameters
- item:
object
Returns any
SetCustomizedStringAsync(string, string)
Section titled "SetCustomizedStringAsync(string, string)"Inherited from: IgbBaseDataSource
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)"Inherited from: IgbBaseDataSource
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
RemoveItemAsync(object)
Section titled "RemoveItemAsync(object)"Inherited from: IgbBaseDataSource
Removes an item from the datasource.
public Task RemoveItemAsync(object item)Parameters
- item:
object
Returns any
RemoveItem(object)
Section titled "RemoveItem(object)"Inherited from: IgbBaseDataSource
public void RemoveItem(object item)Parameters
- item:
object
Returns any
AcceptPendingTransactionAsync(int)
Section titled "AcceptPendingTransactionAsync(int)"Inherited from: IgbBaseDataSource
Save a specific pending transaction.
public Task AcceptPendingTransactionAsync(int transactionID)Parameters
- transactionID:
int
Returns any
AcceptPendingTransaction(int)
Section titled "AcceptPendingTransaction(int)"Inherited from: IgbBaseDataSource
public void AcceptPendingTransaction(int transactionID)Parameters
- transactionID:
int
Returns any
RejectPendingTransactionAsync(int)
Section titled "RejectPendingTransactionAsync(int)"Inherited from: IgbBaseDataSource
Rejects a pending transaction.
public Task RejectPendingTransactionAsync(int transactionID)Parameters
- transactionID:
int
Returns any
RejectPendingTransaction(int)
Section titled "RejectPendingTransaction(int)"Inherited from: IgbBaseDataSource
public void RejectPendingTransaction(int transactionID)Parameters
- transactionID:
int
Returns any
CommitEditsAsync(bool)
Section titled "CommitEditsAsync(bool)"Inherited from: IgbBaseDataSource
Commit the current edits to the datasource.
public Task<int> CommitEditsAsync(bool isPending)Parameters
- isPending:
bool
Returns any
CommitEdits(bool)
Section titled "CommitEdits(bool)"Inherited from: IgbBaseDataSource
public int CommitEdits(bool isPending)Parameters
- isPending:
bool
Returns any
CancelEditsAsync()
Section titled "CancelEditsAsync()"Inherited from: IgbBaseDataSource
Cancels any batched edits that may exist.
public Task CancelEditsAsync()Returns any
CancelEdits()
Section titled "CancelEdits()"Inherited from: IgbBaseDataSource
public void CancelEdits()Returns any
AcceptPendingCommitAsync(int)
Section titled "AcceptPendingCommitAsync(int)"Inherited from: IgbBaseDataSource
Accepts a commit with the provided ID.
public Task AcceptPendingCommitAsync(int commitID)Parameters
- commitID:
int
Returns any
AcceptPendingCommit(int)
Section titled "AcceptPendingCommit(int)"Inherited from: IgbBaseDataSource
public void AcceptPendingCommit(int commitID)Parameters
- commitID:
int
Returns any
RejectPendingCommitAsync(int)
Section titled "RejectPendingCommitAsync(int)"Inherited from: IgbBaseDataSource
Cancel a commit with the provided ID.
public Task RejectPendingCommitAsync(int commitID)Parameters
- commitID:
int
Returns any
RejectPendingCommit(int)
Section titled "RejectPendingCommit(int)"Inherited from: IgbBaseDataSource
public void RejectPendingCommit(int commitID)Parameters
- commitID:
int
Returns any
UndoAsync()
Section titled "UndoAsync()"Inherited from: IgbBaseDataSource
Undo the last edit.
public Task UndoAsync()Returns any
Undo()
Section titled "Undo()"Inherited from: IgbBaseDataSource
public void Undo()Returns any
RedoAsync()
Section titled "RedoAsync()"Inherited from: IgbBaseDataSource
Redo the last undo.
public Task RedoAsync()Returns any
Redo()
Section titled "Redo()"Inherited from: IgbBaseDataSource
public void Redo()Returns any
HasEditAsync(object[], string)
Section titled "HasEditAsync(object[], string)"Inherited from: IgbBaseDataSource
public Task<bool> HasEditAsync(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
HasEdit(object[], string)
Section titled "HasEdit(object[], string)"Inherited from: IgbBaseDataSource
public bool HasEdit(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
HasDeleteAsync(object[])
Section titled "HasDeleteAsync(object[])"Inherited from: IgbBaseDataSource
public Task<bool> HasDeleteAsync(object[] key)Parameters
- key:
object[]
Returns any
HasDelete(object[])
Section titled "HasDelete(object[])"Inherited from: IgbBaseDataSource
public bool HasDelete(object[] key)Parameters
- key:
object[]
Returns any
HasAddAsync(object)
Section titled "HasAddAsync(object)"Inherited from: IgbBaseDataSource
Returns whether the item is an uncommitted add.
public Task<bool> HasAddAsync(object item)Parameters
- item:
object
Returns any
HasAdd(object)
Section titled "HasAdd(object)"Inherited from: IgbBaseDataSource
public bool HasAdd(object item)Parameters
- item:
object
Returns any
GetAggregatedChangesAsync(int)
Section titled "GetAggregatedChangesAsync(int)"Inherited from: IgbBaseDataSource
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
GetAggregatedChanges(int)
Section titled "GetAggregatedChanges(int)"Inherited from: IgbBaseDataSource
public IgbDataSourceAggregatedResult[] GetAggregatedChanges(int commitID)Parameters
- commitID:
int
Returns any
IsPendingTransactionAsync(int)
Section titled "IsPendingTransactionAsync(int)"Inherited from: IgbBaseDataSource
Returns whether a transaction pending or not.
public Task<bool> IsPendingTransactionAsync(int transactionID)Parameters
- transactionID:
int
Returns any
IsPendingTransaction(int)
Section titled "IsPendingTransaction(int)"Inherited from: IgbBaseDataSource
public bool IsPendingTransaction(int transactionID)Parameters
- transactionID:
int
Returns any
IsPendingCommitAsync(int)
Section titled "IsPendingCommitAsync(int)"Inherited from: IgbBaseDataSource
Returns whether a commit is pending or not.
public Task<bool> IsPendingCommitAsync(int commitID)Parameters
- commitID:
int
Returns any
IsPendingCommit(int)
Section titled "IsPendingCommit(int)"Inherited from: IgbBaseDataSource
public bool IsPendingCommit(int commitID)Parameters
- commitID:
int
Returns any
SetTransactionErrorAsync(int, string)
Section titled "SetTransactionErrorAsync(int, string)"Inherited from: IgbBaseDataSource
public Task SetTransactionErrorAsync(int transactionID, string message)Parameters
- transactionID:
int - message:
string
Returns any
SetTransactionError(int, string)
Section titled "SetTransactionError(int, string)"Inherited from: IgbBaseDataSource
public void SetTransactionError(int transactionID, string message)Parameters
- transactionID:
int - message:
string
Returns any
GetTransactionErrorByKeyAsync(object[], string)
Section titled "GetTransactionErrorByKeyAsync(object[], string)"Inherited from: IgbBaseDataSource
public Task<string> GetTransactionErrorByKeyAsync(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
GetTransactionErrorByKey(object[], string)
Section titled "GetTransactionErrorByKey(object[], string)"Inherited from: IgbBaseDataSource
public string GetTransactionErrorByKey(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
GetTransactionErrorByIDAsync(int)
Section titled "GetTransactionErrorByIDAsync(int)"Inherited from: IgbBaseDataSource
Returns an error, if any, associated with a specific transaction.
public Task<string> GetTransactionErrorByIDAsync(int transactionID)Parameters
- transactionID:
int
Returns any
GetTransactionErrorByID(int)
Section titled "GetTransactionErrorByID(int)"Inherited from: IgbBaseDataSource
public string GetTransactionErrorByID(int transactionID)Parameters
- transactionID:
int
Returns any
GetTransactionIDAsync(object[], string)
Section titled "GetTransactionIDAsync(object[], string)"Inherited from: IgbBaseDataSource
public Task<int> GetTransactionIDAsync(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
GetTransactionID(object[], string)
Section titled "GetTransactionID(object[], string)"Inherited from: IgbBaseDataSource
public int GetTransactionID(object[] key, string propertyPath)Parameters
- key:
object[] - propertyPath:
string
Returns any
GetItemPropertyAsync(object, string)
Section titled "GetItemPropertyAsync(object, string)"Inherited from: IgbBaseDataSource
public virtual Task<object> GetItemPropertyAsync(object item, string propertyName)Parameters
- item:
object - propertyName:
string
Returns any
GetItemProperty(object, string)
Section titled "GetItemProperty(object, string)"Inherited from: IgbBaseDataSource
public virtual object GetItemProperty(object item, string propertyName)Parameters
- item:
object - propertyName:
string
Returns any
NotifySetItemAsync(int, object, object)
Section titled "NotifySetItemAsync(int, object, object)"Inherited from: IgbBaseDataSource
public Task NotifySetItemAsync(int index, object oldItem, object newItem)Parameters
- index:
int - oldItem:
object - newItem:
object
Returns any
NotifySetItem(int, object, object)
Section titled "NotifySetItem(int, object, object)"Inherited from: IgbBaseDataSource
public void NotifySetItem(int index, object oldItem, object newItem)Parameters
- index:
int - oldItem:
object - newItem:
object
Returns any
NotifyClearItemsAsync()
Section titled "NotifyClearItemsAsync()"Inherited from: IgbBaseDataSource
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
NotifyClearItems()
Section titled "NotifyClearItems()"Inherited from: IgbBaseDataSource
public void NotifyClearItems()Returns any
NotifyInsertItemAsync(int, object)
Section titled "NotifyInsertItemAsync(int, object)"Inherited from: IgbBaseDataSource
public Task NotifyInsertItemAsync(int index, object newItem)Parameters
- index:
int - newItem:
object
Returns any
NotifyInsertItem(int, object)
Section titled "NotifyInsertItem(int, object)"Inherited from: IgbBaseDataSource
public void NotifyInsertItem(int index, object newItem)Parameters
- index:
int - newItem:
object
Returns any
NotifyRemoveItemAsync(int, object)
Section titled "NotifyRemoveItemAsync(int, object)"Inherited from: IgbBaseDataSource
public Task NotifyRemoveItemAsync(int index, object oldItem)Parameters
- index:
int - oldItem:
object
Returns any
NotifyRemoveItem(int, object)
Section titled "NotifyRemoveItem(int, object)"Inherited from: IgbBaseDataSource
public void NotifyRemoveItem(int index, object oldItem)Parameters
- index:
int - oldItem:
object
Returns any
QueueAutoRefreshAsync()
Section titled "QueueAutoRefreshAsync()"Inherited from: IgbBaseDataSource
Called to manually queue a refresh of the data source.
public Task QueueAutoRefreshAsync()Returns any
QueueAutoRefresh()
Section titled "QueueAutoRefresh()"Inherited from: IgbBaseDataSource
public void QueueAutoRefresh()Returns any
FlushAutoRefreshAsync()
Section titled "FlushAutoRefreshAsync()"Inherited from: IgbBaseDataSource
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
FlushAutoRefresh()
Section titled "FlushAutoRefresh()"Inherited from: IgbBaseDataSource
public void FlushAutoRefresh()Returns any
RefreshAsync()
Section titled "RefreshAsync()"Inherited from: IgbBaseDataSource
Called to synchronously refresh the data source.
public Task RefreshAsync()Returns any
Refresh()
Section titled "Refresh()"Inherited from: IgbBaseDataSource
public void Refresh()Returns any
GetMainValuePathAsync(DataSourceRowType)
Section titled "GetMainValuePathAsync(DataSourceRowType)"Inherited from: IgbBaseDataSource
public virtual Task<string> GetMainValuePathAsync(DataSourceRowType rowType)Parameters
- rowType:
DataSourceRowType
Returns any
GetMainValuePath(DataSourceRowType)
Section titled "GetMainValuePath(DataSourceRowType)"Inherited from: IgbBaseDataSource
public virtual string GetMainValuePath(DataSourceRowType rowType)Parameters
- rowType:
DataSourceRowType
Returns any
IsRowSpanningAsync(DataSourceRowType)
Section titled "IsRowSpanningAsync(DataSourceRowType)"Inherited from: IgbBaseDataSource
public virtual Task<bool> IsRowSpanningAsync(DataSourceRowType rowType)Parameters
- rowType:
DataSourceRowType
Returns any
IsRowSpanning(DataSourceRowType)
Section titled "IsRowSpanning(DataSourceRowType)"Inherited from: IgbBaseDataSource
public virtual bool IsRowSpanning(DataSourceRowType rowType)Parameters
- rowType:
DataSourceRowType
Returns any
ClearPinnedRowsAsync()
Section titled "ClearPinnedRowsAsync()"Inherited from: IgbBaseDataSource
public virtual Task ClearPinnedRowsAsync()Returns any
ClearPinnedRows()
Section titled "ClearPinnedRows()"Inherited from: IgbBaseDataSource
public virtual void ClearPinnedRows()Returns any
ResolveSchemaPropertyTypeAsync(string)
Section titled "ResolveSchemaPropertyTypeAsync(string)"Inherited from: IgbBaseDataSource
Resolve a property or property path to its value type.
public virtual Task<DataSourceSchemaPropertyType> ResolveSchemaPropertyTypeAsync(string propertyPath)Parameters
- propertyPath:
string
Returns any
ResolveSchemaPropertyType(string)
Section titled "ResolveSchemaPropertyType(string)"Inherited from: IgbBaseDataSource
public virtual DataSourceSchemaPropertyType ResolveSchemaPropertyType(string propertyPath)Parameters
- propertyPath:
string
Returns any
GetRowCountAsync()
Section titled "GetRowCountAsync()"Inherited from: IgbBaseDataSource
Gets the current actual full count of the items in the data source.
public virtual Task<int> GetRowCountAsync()Returns any
GetRowCount()
Section titled "GetRowCount()"Inherited from: IgbBaseDataSource
public virtual int GetRowCount()Returns any
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
Clone()
Section titled "Clone()"public override 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 override Task<DataSource> CloneAsync()Returns any
CloneProperties(DataSource)
Section titled "CloneProperties(DataSource)"public override void CloneProperties(DataSource dataSource)Parameters
- dataSource:
DataSource
Returns any
ClonePropertiesAsync(DataSource)
Section titled "ClonePropertiesAsync(DataSource)"Clones the properties over to the provided datasource.
public override Task ClonePropertiesAsync(DataSource dataSource)Parameters
- dataSource:
DataSource
Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
GetIsRowExpandedAtIndex(int)
Section titled "GetIsRowExpandedAtIndex(int)"public override bool GetIsRowExpandedAtIndex(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetIsRowExpandedAtIndexAsync(int)
Section titled "GetIsRowExpandedAtIndexAsync(int)"Gets the expansion state for a row.
public override Task<bool> GetIsRowExpandedAtIndexAsync(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetItemAtIndex(int)
Section titled "GetItemAtIndex(int)"public override object GetItemAtIndex(int index)Parameters
- index:
int
Returns any
GetItemAtIndexAsync(int)
Section titled "GetItemAtIndexAsync(int)"Gets the item at the requested index. May return null, in which case you may want to check if that null represents a placeholder for a virtual item.
public override Task<object> GetItemAtIndexAsync(int index)Parameters
- index:
int
Returns any
GetItemFromKey(object[])
Section titled "GetItemFromKey(object[])"public override object GetItemFromKey(object[] key)Parameters
- key:
object[]
Returns any
GetItemFromKeyAsync(object[])
Section titled "GetItemFromKeyAsync(object[])"public override Task<object> GetItemFromKeyAsync(object[] key)Parameters
- key:
object[]
Returns any
GetItemPropertyAtIndex(int, string)
Section titled "GetItemPropertyAtIndex(int, string)"public override object GetItemPropertyAtIndex(int index, string valueName)Parameters
- index:
int - valueName:
string
Returns any
GetItemPropertyAtIndexAsync(int, string)
Section titled "GetItemPropertyAtIndexAsync(int, string)"public override Task<object> GetItemPropertyAtIndexAsync(int index, string valueName)Parameters
- index:
int - valueName:
string
Returns any
GetRootSummaryResults()
Section titled "GetRootSummaryResults()"public override IgbDataGridSummaryResult[] GetRootSummaryResults()Returns any
GetRootSummaryResultsAsync()
Section titled "GetRootSummaryResultsAsync()"Gets the summary results for the root level.
public override Task<IgbDataGridSummaryResult[]> GetRootSummaryResultsAsync()Returns any
GetRootSummaryRowCount()
Section titled "GetRootSummaryRowCount()"public override int GetRootSummaryRowCount()Returns any
GetRootSummaryRowCountAsync()
Section titled "GetRootSummaryRowCountAsync()"Gets the number of summary rows at the root level.
public override Task<int> GetRootSummaryRowCountAsync()Returns any
GetRowLevel(int)
Section titled "GetRowLevel(int)"public override int GetRowLevel(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetRowLevelAsync(int)
Section titled "GetRowLevelAsync(int)"Gets the hierarchy level of the row.
public override Task<int> GetRowLevelAsync(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetRowType(int)
Section titled "GetRowType(int)"public override DataSourceRowType GetRowType(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetRowTypeAsync(int)
Section titled "GetRowTypeAsync(int)"public override Task<DataSourceRowType> GetRowTypeAsync(int rowIndex)Parameters
- rowIndex:
int
Returns any
GetSectionSummaryResults(int)
Section titled "GetSectionSummaryResults(int)"public override IgbDataGridSummaryResult[][] GetSectionSummaryResults(int sectionIndex)Parameters
- sectionIndex:
int
Returns any
GetSectionSummaryResultsAsync(int)
Section titled "GetSectionSummaryResultsAsync(int)"Gets the summary results for a specific section.
public override Task<IgbDataGridSummaryResult[][]> GetSectionSummaryResultsAsync(int sectionIndex)Parameters
- sectionIndex:
int
Returns any
GetStickyRowPriority(int)
Section titled "GetStickyRowPriority(int)"public override int GetStickyRowPriority(int row)Parameters
- row:
int
Returns any
GetStickyRowPriorityAsync(int)
Section titled "GetStickyRowPriorityAsync(int)"public override Task<int> GetStickyRowPriorityAsync(int row)Parameters
- row:
int
Returns any
GetUnrealizedCount()
Section titled "GetUnrealizedCount()"public virtual int GetUnrealizedCount()Returns any
GetUnrealizedCountAsync()
Section titled "GetUnrealizedCountAsync()"Gets the number of unrealized or virtual items.
public virtual Task<int> GetUnrealizedCountAsync()Returns any
IndexOfItem(object)
Section titled "IndexOfItem(object)"public override 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 override Task<int> IndexOfItemAsync(object item)Parameters
- item:
object
Returns any
IndexOfKey(object[])
Section titled "IndexOfKey(object[])"public override int IndexOfKey(object[] key)Parameters
- key:
object[]
Returns any
IndexOfKeyAsync(object[])
Section titled "IndexOfKeyAsync(object[])"public override Task<int> IndexOfKeyAsync(object[] key)Parameters
- key:
object[]
Returns any
IsExclusivelySticky(int)
Section titled "IsExclusivelySticky(int)"public override bool IsExclusivelySticky(int row)Parameters
- row:
int
Returns any
IsExclusivelyStickyAsync(int)
Section titled "IsExclusivelyStickyAsync(int)"public override Task<bool> IsExclusivelyStickyAsync(int row)Parameters
- row:
int
Returns any
IsPlaceholderItem(int)
Section titled "IsPlaceholderItem(int)"public override bool IsPlaceholderItem(int index)Parameters
- index:
int
Returns any
IsPlaceholderItemAsync(int)
Section titled "IsPlaceholderItemAsync(int)"Returns whether the item at the requested index is a placeholder for a virtual item which has yet to be loaded.
public override Task<bool> IsPlaceholderItemAsync(int index)Parameters
- index:
int
Returns any
IsRowPinned(int)
Section titled "IsRowPinned(int)"public override bool IsRowPinned(int row)Parameters
- row:
int
Returns any
IsRowPinnedAsync(int)
Section titled "IsRowPinnedAsync(int)"public override Task<bool> IsRowPinnedAsync(int row)Parameters
- row:
int
Returns any
PinRow(object[])
Section titled "PinRow(object[])"public override void PinRow(object[] key)Parameters
- key:
object[]
Returns any
PinRowAsync(object[])
Section titled "PinRowAsync(object[])"public override Task PinRowAsync(object[] key)Parameters
- key:
object[]
Returns any
RemoveItemByKey(object[])
Section titled "RemoveItemByKey(object[])"public override void RemoveItemByKey(object[] key)Parameters
- key:
object[]
Returns any
RemoveItemByKeyAsync(object[])
Section titled "RemoveItemByKeyAsync(object[])"public override Task RemoveItemByKeyAsync(object[] key)Parameters
- key:
object[]
Returns any
SetIsRowExpandedAtIndex(int, bool)
Section titled "SetIsRowExpandedAtIndex(int, bool)"public override void SetIsRowExpandedAtIndex(int rowIndex, bool isExpanded)Parameters
- rowIndex:
int - isExpanded:
bool
Returns any
SetIsRowExpandedAtIndexAsync(int, bool)
Section titled "SetIsRowExpandedAtIndexAsync(int, bool)"public override Task SetIsRowExpandedAtIndexAsync(int rowIndex, bool isExpanded)Parameters
- rowIndex:
int - isExpanded:
bool
Returns any
TransformPage(int)
Section titled "TransformPage(int)"public int[] TransformPage(int pageIndex)Parameters
- pageIndex:
int
Returns any
TransformPageAsync(int)
Section titled "TransformPageAsync(int)"public Task<int[]> TransformPageAsync(int pageIndex)Parameters
- pageIndex:
int
Returns any
UnpinRow(object[])
Section titled "UnpinRow(object[])"public override void UnpinRow(object[] key)Parameters
- key:
object[]
Returns any
UnpinRowAsync(object[])
Section titled "UnpinRowAsync(object[])"public override Task UnpinRowAsync(object[] key)Parameters
- key:
object[]
Returns any
UpdatePropertyAtKey(object[], string, object, bool)
Section titled "UpdatePropertyAtKey(object[], string, object, bool)"public override 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 override 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"SchemaChanged
Section titled "SchemaChanged"[Parameter]
public EventCallback<IgbDataSourceSchemaChangedEventArgs> SchemaChanged { get; set; }RowExpansionChanged
Section titled "RowExpansionChanged"[Parameter]
public EventCallback<IgbDataSourceRowExpansionChangedEventArgs> RowExpansionChanged { get; set; }RootSummariesChanged
Section titled "RootSummariesChanged"[Parameter]
public EventCallback<IgbDataSourceRootSummariesChangedEventArgs> RootSummariesChanged { get; set; }PropertiesRequestedChanged
Section titled "PropertiesRequestedChanged"[Parameter]
public EventCallback<IgbDataSourcePropertiesRequestedChangedEventArgs> PropertiesRequestedChanged { get; set; }SchemaChangedScript
Section titled "SchemaChangedScript"[Parameter]
public string SchemaChangedScript { get; set; }RowExpansionChangedScript
Section titled "RowExpansionChangedScript"[Parameter]
public string RowExpansionChangedScript { get; set; }RootSummariesChangedScript
Section titled "RootSummariesChangedScript"[Parameter]
public string RootSummariesChangedScript { get; set; }PropertiesRequestedChangedScript
Section titled "PropertiesRequestedChangedScript"[Parameter]
public string PropertiesRequestedChangedScript { get; set; }