Class IgbVirtualDataSource

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
System.Object
BaseRendererElement
IgbBaseDataSource
IgbVirtualDataSource
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbVirtualDataSource : IgbBaseDataSource, JsonSerializable

Constructors

IgbVirtualDataSource()

Declaration
public IgbVirtualDataSource()

Properties

ActualPageSize

Gets the actual resolved page size that will be used.

Declaration
public int ActualPageSize { get; set; }
Property Value
Type Description
System.Int32

ConcurrencyTag

Gets or sets the field to use for concurrency. I.e. @odata.etag for odata, RowVersion for sql, etc.

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

IsBatchingEnabled

Gets whether batch edits are enabled. Setting this property will have no effect.

Declaration
public override bool IsBatchingEnabled { get; set; }
Property Value
Type Description
System.Boolean
Overrides

IsSectionCollapsable

Declaration
public override bool IsSectionCollapsable { get; set; }
Property Value
Type Description
System.Boolean
Overrides

IsSectionExpandedDefault

Declaration
public override bool IsSectionExpandedDefault { get; set; }
Property Value
Type Description
System.Boolean
Overrides

MaxCachedPages

Gets or sets the maximum number of data pages to cache in the data source before the oldest pages will start being evicted.

Declaration
public int MaxCachedPages { get; set; }
Property Value
Type Description
System.Int32

PageSizeRequested

Gets or sets the desired page size. This may or may not be respected by the underlying provider, or its connected services.

Declaration
public int PageSizeRequested { get; set; }
Property Value
Type Description
System.Int32

Type

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

Methods

Clone()

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

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

CloneProperties(DataSource)

Declaration
public override void CloneProperties(DataSource dataSource)
Parameters
Type Name Description
DataSource dataSource
Overrides

ClonePropertiesAsync(DataSource)

Clones the properties over to the provided datasource.

Declaration
public override Task ClonePropertiesAsync(DataSource dataSource)
Parameters
Type Name Description
DataSource dataSource

The datasource to update.
Returns
Type Description
System.Threading.Tasks.Task
Overrides

FindByName(String)

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

GetIsRowExpandedAtIndex(Int32)

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

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

GetItemAtIndex(Int32)

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

GetItemAtIndexAsync(Int32)

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.

Declaration
public override Task<object> GetItemAtIndexAsync(int index)
Parameters
Type Name Description
System.Int32 index

The index of the item to retrieve.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>
Overrides

GetItemFromKey(Object[])

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

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

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

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

GetRootSummaryResults()

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

GetRootSummaryResultsAsync()

Gets the summary results for the root level.

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

GetRootSummaryRowCount()

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

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

GetRowLevel(Int32)

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

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

GetRowType(Int32)

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

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

GetSectionSummaryResults(Int32)

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

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

GetStickyRowPriority(Int32)

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

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

GetUnrealizedCount()

Declaration
public virtual int GetUnrealizedCount()
Returns
Type Description
System.Int32

GetUnrealizedCountAsync()

Gets the number of unrealized or virtual items.

Declaration
public virtual Task<int> GetUnrealizedCountAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

IndexOfItem(Object)

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

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

IndexOfKey(Object[])

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

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

IsExclusivelySticky(Int32)

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

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

IsPlaceholderItem(Int32)

Declaration
public override bool IsPlaceholderItem(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
System.Boolean
Overrides

IsPlaceholderItemAsync(Int32)

Returns whether the item at the requested index is a placeholder for a virtual item which has yet to be loaded.

Declaration
public override Task<bool> IsPlaceholderItemAsync(int index)
Parameters
Type Name Description
System.Int32 index

The index of the item to check.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides

IsRowPinned(Int32)

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

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

PinRow(Object[])

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

PinRowAsync(Object[])

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

RemoveItemByKey(Object[])

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

RemoveItemByKeyAsync(Object[])

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

SetIsRowExpandedAtIndex(Int32, Boolean)

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

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

TransformPage(Int32)

Declaration
public int[] TransformPage(int pageIndex)
Parameters
Type Name Description
System.Int32 pageIndex
Returns
Type Description
System.Int32[]

TransformPageAsync(Int32)

Declaration
public Task<int[]> TransformPageAsync(int pageIndex)
Parameters
Type Name Description
System.Int32 pageIndex
Returns
Type Description
System.Threading.Tasks.Task<System.Int32[]>

UnpinRow(Object[])

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

UnpinRowAsync(Object[])

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

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

Declaration
public override 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
Overrides

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

Declaration
public override 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>
Overrides

Implements