Interface DataSourceDataProvider

Represents an interface that can be implemented to create a data provider for a data source.

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public interface DataSourceDataProvider

Properties

DeferAutoRefresh

Declaration

bool DeferAutoRefresh { get; set; }

Property Value

Type	Description
System.Boolean

ExecutionContext

Declaration

DataSourceExecutionContext ExecutionContext { get; set; }

Property Value

Type	Description
DataSourceExecutionContext

FilterExpressions

Declaration

IgbFilterExpressionCollection FilterExpressions { get; }

Property Value

Type	Description
IgbFilterExpressionCollection

PropertiesRequested

Declaration

string[] PropertiesRequested { get; set; }

Property Value

Type	Description
System.String[]

SchemaIncludedProperties

Declaration

string[] SchemaIncludedProperties { get; set; }

Property Value

Type	Description
System.String[]

SummaryScope

Declaration

DataSourceSummaryScope SummaryScope { get; set; }

Property Value

Type	Description
DataSourceSummaryScope

UpdateNotifier

Declaration

DataSourceDataProviderUpdateNotifier UpdateNotifier { get; set; }

Property Value

Type	Description
DataSourceDataProviderUpdateNotifier

Methods

AddItem(Object)

Declaration

void AddItem(object item)

Parameters

Type	Name	Description
System.Object	item

AddItemAsync(Object)

Adds the item to the data.

Declaration

Task AddItemAsync(object item)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

FlushAutoRefresh()

Declaration

void FlushAutoRefresh()

FlushAutoRefreshAsync()

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

Declaration

Task FlushAutoRefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

GetItemValue(Object, String)

Declaration

object GetItemValue(object item, string valueName)

Parameters

Type	Name	Description
System.Object	item
System.String	valueName

Returns

Type	Description
System.Object

GetItemValueAsync(Object, String)

Declaration

Task<object> GetItemValueAsync(object item, string valueName)

Parameters

Type	Name	Description
System.Object	item
System.String	valueName

Returns

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

IndexOfItem(Object)

Declaration

int IndexOfItem(object item)

Parameters

Type	Name	Description
System.Object	item

Returns

Type	Description
System.Int32

IndexOfItemAsync(Object)

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

Declaration

Task<int> IndexOfItemAsync(object item)

Parameters

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

Returns

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

IndexOfKey(Object[])

Declaration

int IndexOfKey(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Int32

IndexOfKeyAsync(Object[])

Declaration

Task<int> IndexOfKeyAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

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

QueueAutoRefresh()

Declaration

void QueueAutoRefresh()

QueueAutoRefreshAsync()

Called to manually queue a refresh of the data provider.

Declaration

Task QueueAutoRefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Refresh()

Declaration

void Refresh()

RefreshAsync()

Called to synchronously refresh the data provider.

Declaration

Task RefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

RemoveItem(Object)

Declaration

void RemoveItem(object item)

Parameters

Type	Name	Description
System.Object	item

RemoveItemAsync(Object)

Removes the item from the data.

Declaration

Task RemoveItemAsync(object item)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

ResolveSchemaPropertyType(String)

Declaration

DataSourceSchemaPropertyType ResolveSchemaPropertyType(string propertyPath)

Parameters

Type	Name	Description
System.String	propertyPath

Returns

Type	Description
DataSourceSchemaPropertyType

ResolveSchemaPropertyTypeAsync(String)

Resolve a property or property path to its value type.

Declaration

Task<DataSourceSchemaPropertyType> ResolveSchemaPropertyTypeAsync(string propertyPath)

Parameters

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

Returns

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

SetItemValue(Object, String, Object)

Declaration

void SetItemValue(object item, string valueName, object value)

Parameters

Type	Name	Description
System.Object	item
System.String	valueName
System.Object	value

SetItemValueAsync(Object, String, Object)

Declaration

Task SetItemValueAsync(object item, string valueName, object value)

Parameters

Type	Name	Description
System.Object	item
System.String	valueName
System.Object	value

Returns

Type	Description
System.Threading.Tasks.Task