Show / Hide Table of Contents

Class IgbLocalDataSource

A local data source which has synchronous access to its data items.

Inheritance
System.Object
BaseRendererElement
IgbBaseDataSource
IgbLocalDataSource
IgbPagedDataSource
Implements
JsonSerializable
Inherited Members
IgbBaseDataSource.AddItemAsync(Object)
IgbBaseDataSource.AddItem(Object)
IgbBaseDataSource.SetCustomizedStringAsync(String, String)
IgbBaseDataSource.SetCustomizedStringAsync(String, String, String)
IgbBaseDataSource.UpdatePropertyAtKeyAsync(Object[], String, Object, Boolean)
IgbBaseDataSource.UpdatePropertyAtKey(Object[], String, Object, Boolean)
IgbBaseDataSource.RemoveItemByKeyAsync(Object[])
IgbBaseDataSource.RemoveItemByKey(Object[])
IgbBaseDataSource.RemoveItemAsync(Object)
IgbBaseDataSource.RemoveItem(Object)
IgbBaseDataSource.AcceptPendingTransactionAsync(Int32)
IgbBaseDataSource.AcceptPendingTransaction(Int32)
IgbBaseDataSource.RejectPendingTransactionAsync(Int32)
IgbBaseDataSource.RejectPendingTransaction(Int32)
IgbBaseDataSource.CommitEditsAsync(Boolean)
IgbBaseDataSource.CommitEdits(Boolean)
IgbBaseDataSource.CancelEditsAsync()
IgbBaseDataSource.CancelEdits()
IgbBaseDataSource.AcceptPendingCommitAsync(Int32)
IgbBaseDataSource.AcceptPendingCommit(Int32)
IgbBaseDataSource.RejectPendingCommitAsync(Int32)
IgbBaseDataSource.RejectPendingCommit(Int32)
IgbBaseDataSource.UndoAsync()
IgbBaseDataSource.Undo()
IgbBaseDataSource.RedoAsync()
IgbBaseDataSource.Redo()
IgbBaseDataSource.HasEditAsync(Object[], String)
IgbBaseDataSource.HasEdit(Object[], String)
IgbBaseDataSource.HasDeleteAsync(Object[])
IgbBaseDataSource.HasDelete(Object[])
IgbBaseDataSource.HasAddAsync(Object)
IgbBaseDataSource.HasAdd(Object)
IgbBaseDataSource.GetAggregatedChangesAsync(Int32)
IgbBaseDataSource.GetAggregatedChanges(Int32)
IgbBaseDataSource.IsPendingTransactionAsync(Int32)
IgbBaseDataSource.IsPendingTransaction(Int32)
IgbBaseDataSource.IsPendingCommitAsync(Int32)
IgbBaseDataSource.IsPendingCommit(Int32)
IgbBaseDataSource.SetTransactionErrorAsync(Int32, String)
IgbBaseDataSource.SetTransactionError(Int32, String)
IgbBaseDataSource.GetTransactionErrorByKeyAsync(Object[], String)
IgbBaseDataSource.GetTransactionErrorByKey(Object[], String)
IgbBaseDataSource.GetTransactionErrorByIDAsync(Int32)
IgbBaseDataSource.GetTransactionErrorByID(Int32)
IgbBaseDataSource.GetTransactionIDAsync(Object[], String)
IgbBaseDataSource.GetTransactionID(Object[], String)
IgbBaseDataSource.IsPlaceholderItemAsync(Int32)
IgbBaseDataSource.IsPlaceholderItem(Int32)
IgbBaseDataSource.GetItemPropertyAsync(Object, String)
IgbBaseDataSource.GetItemProperty(Object, String)
IgbBaseDataSource.NotifySetItemAsync(Int32, Object, Object)
IgbBaseDataSource.NotifySetItem(Int32, Object, Object)
IgbBaseDataSource.NotifyClearItemsAsync()
IgbBaseDataSource.NotifyClearItems()
IgbBaseDataSource.NotifyInsertItemAsync(Int32, Object)
IgbBaseDataSource.NotifyInsertItem(Int32, Object)
IgbBaseDataSource.NotifyRemoveItemAsync(Int32, Object)
IgbBaseDataSource.NotifyRemoveItem(Int32, Object)
IgbBaseDataSource.QueueAutoRefreshAsync()
IgbBaseDataSource.QueueAutoRefresh()
IgbBaseDataSource.FlushAutoRefreshAsync()
IgbBaseDataSource.FlushAutoRefresh()
IgbBaseDataSource.RefreshAsync()
IgbBaseDataSource.Refresh()
IgbBaseDataSource.GetMainValuePathAsync(DataSourceRowType)
IgbBaseDataSource.GetMainValuePath(DataSourceRowType)
IgbBaseDataSource.IsRowSpanningAsync(DataSourceRowType)
IgbBaseDataSource.IsRowSpanning(DataSourceRowType)
IgbBaseDataSource.ResolveSchemaPropertyTypeAsync(String)
IgbBaseDataSource.ResolveSchemaPropertyType(String)
IgbBaseDataSource.ClonePropertiesAsync(DataSource)
IgbBaseDataSource.CloneProperties(DataSource)
IgbBaseDataSource.GetRowCountAsync()
IgbBaseDataSource.GetRowCount()
IgbBaseDataSource.IsReadOnly
IgbBaseDataSource.IsBatchingEnabled
IgbBaseDataSource.ActualCount
IgbBaseDataSource.FirstVisibleIndexRequested
IgbBaseDataSource.LastVisibleIndexRequested
IgbBaseDataSource.DeferAutoRefresh
IgbBaseDataSource.PrimaryKey
IgbBaseDataSource.PropertiesRequested
IgbBaseDataSource.SchemaIncludedProperties
IgbBaseDataSource.SectionHeaderDisplayMode
IgbBaseDataSource.IsSectionCollapsable
IgbBaseDataSource.IsSectionExpandedDefault
IgbBaseDataSource.IncludeSummaryRowsInSection
IgbBaseDataSource.IsSectionSummaryRowsAtBottom
IgbBaseDataSource.IsSectionHeaderNormalRow
IgbBaseDataSource.IsSectionContentVisible
IgbBaseDataSource.ShouldEmitSectionHeaders
IgbBaseDataSource.ShouldEmitSectionFooters
IgbBaseDataSource.ShouldEmitShiftedRows
IgbBaseDataSource.ShouldEmitSummaryRows
IgbBaseDataSource.SchemaChangedScript
IgbBaseDataSource.SchemaChanged
IgbBaseDataSource.RowExpansionChangedScript
IgbBaseDataSource.RowExpansionChanged
IgbBaseDataSource.RootSummariesChangedScript
IgbBaseDataSource.RootSummariesChanged
IgbBaseDataSource.PropertiesRequestedChangedScript
IgbBaseDataSource.PropertiesRequestedChanged
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 IgbLocalDataSource : IgbBaseDataSource, JsonSerializable

Constructors

IgbLocalDataSource()

Declaration
public IgbLocalDataSource()

Properties

DataSource

Gets or sets the backing data for the data source.

Declaration
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

Declaration
public string DataSourceScript { get; set; }
Property Value
Type Description
System.String

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides
IgbBaseDataSource.Type

Methods

ClearPinnedRows()

Declaration
public override void ClearPinnedRows()
Overrides
IgbBaseDataSource.ClearPinnedRows()

ClearPinnedRowsAsync()

Declaration
public override Task ClearPinnedRowsAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
IgbBaseDataSource.ClearPinnedRowsAsync()

Clone()

Declaration
public override DataSource Clone()
Returns
Type Description
DataSource
Overrides
IgbBaseDataSource.Clone()

CloneAsync()

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

Declaration
public override Task<DataSource> CloneAsync()
Returns
Type Description
System.Threading.Tasks.Task<DataSource>
Overrides
IgbBaseDataSource.CloneAsync()

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides
IgbBaseDataSource.FindByName(String)

GetIsRowExpandedAtIndex(Int32)

Declaration
public override bool GetIsRowExpandedAtIndex(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex
Returns
Type Description
System.Boolean
Overrides
IgbBaseDataSource.GetIsRowExpandedAtIndex(Int32)

GetIsRowExpandedAtIndexAsync(Int32)

Declaration
public override Task<bool> GetIsRowExpandedAtIndexAsync(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides
IgbBaseDataSource.GetIsRowExpandedAtIndexAsync(Int32)

GetItemAtIndex(Int32)

Declaration
public override object GetItemAtIndex(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
System.Object
Overrides
IgbBaseDataSource.GetItemAtIndex(Int32)

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 override 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>
Overrides
IgbBaseDataSource.GetItemAtIndexAsync(Int32)

GetItemFromKey(Object[])

Declaration
public override object GetItemFromKey(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Object
Overrides
IgbBaseDataSource.GetItemFromKey(Object[])

GetItemFromKeyAsync(Object[])

Declaration
public override Task<object> GetItemFromKeyAsync(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Threading.Tasks.Task<System.Object>
Overrides
IgbBaseDataSource.GetItemFromKeyAsync(Object[])

GetItemPropertyAtIndex(Int32, String)

Declaration
public override object GetItemPropertyAtIndex(int index, string valueName)
Parameters
Type Name Description
System.Int32 index
System.String valueName
Returns
Type Description
System.Object
Overrides
IgbBaseDataSource.GetItemPropertyAtIndex(Int32, String)

GetItemPropertyAtIndexAsync(Int32, String)

Declaration
public override 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>
Overrides
IgbBaseDataSource.GetItemPropertyAtIndexAsync(Int32, String)

GetRootSummaryResults()

Declaration
public override IgbDataGridSummaryResult[] GetRootSummaryResults()
Returns
Type Description
IgbDataGridSummaryResult[]
Overrides
IgbBaseDataSource.GetRootSummaryResults()

GetRootSummaryResultsAsync()

Gets the summary results for the root level.

Declaration
public override Task<IgbDataGridSummaryResult[]> GetRootSummaryResultsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbDataGridSummaryResult[]>
Overrides
IgbBaseDataSource.GetRootSummaryResultsAsync()

GetRootSummaryRowCount()

Declaration
public override int GetRootSummaryRowCount()
Returns
Type Description
System.Int32
Overrides
IgbBaseDataSource.GetRootSummaryRowCount()

GetRootSummaryRowCountAsync()

Gets the number of summary rows at the root level.

Declaration
public override Task<int> GetRootSummaryRowCountAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides
IgbBaseDataSource.GetRootSummaryRowCountAsync()

GetRowLevel(Int32)

Declaration
public override int GetRowLevel(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex
Returns
Type Description
System.Int32
Overrides
IgbBaseDataSource.GetRowLevel(Int32)

GetRowLevelAsync(Int32)

Declaration
public override Task<int> GetRowLevelAsync(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides
IgbBaseDataSource.GetRowLevelAsync(Int32)

GetRowType(Int32)

Declaration
public override DataSourceRowType GetRowType(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex
Returns
Type Description
DataSourceRowType
Overrides
IgbBaseDataSource.GetRowType(Int32)

GetRowTypeAsync(Int32)

Declaration
public override Task<DataSourceRowType> GetRowTypeAsync(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex
Returns
Type Description
System.Threading.Tasks.Task<DataSourceRowType>
Overrides
IgbBaseDataSource.GetRowTypeAsync(Int32)

GetSectionSummaryResults(Int32)

Declaration
public override IgbDataGridSummaryResult[][] GetSectionSummaryResults(int sectionIndex)
Parameters
Type Name Description
System.Int32 sectionIndex
Returns
Type Description
IgbDataGridSummaryResult[][]
Overrides
IgbBaseDataSource.GetSectionSummaryResults(Int32)

GetSectionSummaryResultsAsync(Int32)

Gets the summary results for a specific section.

Declaration
public override Task<IgbDataGridSummaryResult[][]> GetSectionSummaryResultsAsync(int sectionIndex)
Parameters
Type Name Description
System.Int32 sectionIndex
Returns
Type Description
System.Threading.Tasks.Task<IgbDataGridSummaryResult[][]>
Overrides
IgbBaseDataSource.GetSectionSummaryResultsAsync(Int32)

GetStickyRowPriority(Int32)

Declaration
public override int GetStickyRowPriority(int row)
Parameters
Type Name Description
System.Int32 row
Returns
Type Description
System.Int32
Overrides
IgbBaseDataSource.GetStickyRowPriority(Int32)

GetStickyRowPriorityAsync(Int32)

Declaration
public override Task<int> GetStickyRowPriorityAsync(int row)
Parameters
Type Name Description
System.Int32 row
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides
IgbBaseDataSource.GetStickyRowPriorityAsync(Int32)

IndexOfItem(Object)

Declaration
public override int IndexOfItem(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
System.Int32
Overrides
IgbBaseDataSource.IndexOfItem(Object)

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 override 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>
Overrides
IgbBaseDataSource.IndexOfItemAsync(Object)

IndexOfKey(Object[])

Declaration
public override int IndexOfKey(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Int32
Overrides
IgbBaseDataSource.IndexOfKey(Object[])

IndexOfKeyAsync(Object[])

Declaration
public override Task<int> IndexOfKeyAsync(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides
IgbBaseDataSource.IndexOfKeyAsync(Object[])

IsExclusivelySticky(Int32)

Declaration
public override bool IsExclusivelySticky(int row)
Parameters
Type Name Description
System.Int32 row
Returns
Type Description
System.Boolean
Overrides
IgbBaseDataSource.IsExclusivelySticky(Int32)

IsExclusivelyStickyAsync(Int32)

Declaration
public override Task<bool> IsExclusivelyStickyAsync(int row)
Parameters
Type Name Description
System.Int32 row
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides
IgbBaseDataSource.IsExclusivelyStickyAsync(Int32)

IsRowPinned(Int32)

Declaration
public override bool IsRowPinned(int row)
Parameters
Type Name Description
System.Int32 row
Returns
Type Description
System.Boolean
Overrides
IgbBaseDataSource.IsRowPinned(Int32)

IsRowPinnedAsync(Int32)

Declaration
public override Task<bool> IsRowPinnedAsync(int row)
Parameters
Type Name Description
System.Int32 row
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides
IgbBaseDataSource.IsRowPinnedAsync(Int32)

PinRow(Object[])

Declaration
public override void PinRow(object[] key)
Parameters
Type Name Description
System.Object[] key
Overrides
IgbBaseDataSource.PinRow(Object[])

PinRowAsync(Object[])

Declaration
public override Task PinRowAsync(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Threading.Tasks.Task
Overrides
IgbBaseDataSource.PinRowAsync(Object[])

SetIsRowExpandedAtIndex(Int32, Boolean)

Declaration
public override void SetIsRowExpandedAtIndex(int rowIndex, bool isExpanded)
Parameters
Type Name Description
System.Int32 rowIndex
System.Boolean isExpanded
Overrides
IgbBaseDataSource.SetIsRowExpandedAtIndex(Int32, Boolean)

SetIsRowExpandedAtIndexAsync(Int32, Boolean)

Declaration
public override Task SetIsRowExpandedAtIndexAsync(int rowIndex, bool isExpanded)
Parameters
Type Name Description
System.Int32 rowIndex
System.Boolean isExpanded
Returns
Type Description
System.Threading.Tasks.Task
Overrides
IgbBaseDataSource.SetIsRowExpandedAtIndexAsync(Int32, Boolean)

UnpinRow(Object[])

Declaration
public override void UnpinRow(object[] key)
Parameters
Type Name Description
System.Object[] key
Overrides
IgbBaseDataSource.UnpinRow(Object[])

UnpinRowAsync(Object[])

Declaration
public override Task UnpinRowAsync(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Threading.Tasks.Task
Overrides
IgbBaseDataSource.UnpinRowAsync(Object[])

Implements

JsonSerializable