Back to all docs
API Reference / Telerik.Windows.Controls.VirtualGrid / DataProvider
New to Telerik UI for WPF? Start a free 30-day trial

DataProvider

Class

Represent a set of members that functionally affects RadVirtualGrid. They can be overridden to modify its behavior.

Definition

Namespace:Telerik.Windows.Controls.VirtualGrid

Assembly:Telerik.Windows.Controls.VirtualGrid.dll

Syntax:
C#
public class DataProvider

Inheritance: objectDataProvider

Constructors

DataProvider(IEnumerable)

Initializes a new instance of the DataProvider class.

C#
public DataProvider(IEnumerable source)
Parameters:sourceIEnumerable

The source.

Properties

DistinctValuesLimit

Gets or sets the maximum count of distinct values.

C#
public int DistinctValuesLimit { get; set; }

InitialColumnCount

Represents the initial column count.

C#
protected virtual int InitialColumnCount { get; }

InitialRowCount

Represents the initial row count.

C#
protected virtual int InitialRowCount { get; }

ItemProperties

IList<ItemPropertyInfo>

Gets the item properties.

C#
public virtual IList<ItemPropertyInfo> ItemProperties { get; }
Property Value:

The item properties.

ParentGrid

Gets or sets the instance of the RadVirtualGrid that uses the DataProvider.

C#
protected RadVirtualGrid ParentGrid { get; set; }

ShouldPushEditValueToGrid

Gets a value that indicates whether the new cell value should be pushed to VirtualGrid after CellEditEnded.

C#
protected virtual bool ShouldPushEditValueToGrid { get; }

Source

Gets or sets a Source QCV collection that enables data operations.

C#
protected QueryableCollectionView Source { get; set; }

Methods

ApplyFilterDescriptor(ColumnFilterDescriptor)

Adds the filter descriptor to the Source QCV.

C#
protected virtual void ApplyFilterDescriptor(ColumnFilterDescriptor descriptor)
Parameters:descriptorColumnFilterDescriptor

ApplySortDescriptor(ColumnSortDescriptor)

Adds the sort descriptor to the Source QCV.

C#
protected virtual void ApplySortDescriptor(ColumnSortDescriptor descriptor)
Parameters:descriptorColumnSortDescriptor

CreateEditor(out FrameworkElement, out DependencyProperty, object, int)

Creates an editor.

C#
protected virtual void CreateEditor(out FrameworkElement editor, out DependencyProperty editorProperty, object propertyValue, int columnIndex)
Parameters:editorFrameworkElementeditorPropertyDependencyPropertypropertyValueobjectcolumnIndexint

DataMemberNeeded(DataMemberEventArgs)

Assigns the DataMemberEventArgs properties based on the values in ItemProperties.

C#
protected virtual void DataMemberNeeded(DataMemberEventArgs e)
Parameters:eDataMemberEventArgs

DistinctValuesLoading(DistinctValuesLoadingEventArgs)

Initializes DistinctValuesLoadingEventArgs.ItemsSource based on ItemProperties value.

C#
protected virtual void DistinctValuesLoading(DistinctValuesLoadingEventArgs e)
Parameters:eDistinctValuesLoadingEventArgs

FilterDescriptorsPrepared(FilteredEventArgs)

The method is called when the FilterDescriptors are prepared and a filter operation will occur.

C#
protected virtual void FilterDescriptorsPrepared(FilteredEventArgs e)
Parameters:eFilteredEventArgs

FilterDescriptorsPreparing(FilteringEventArgs)

The method is called when the FilterDescriptors are being prepared.

C#
protected virtual void FilterDescriptorsPreparing(FilteringEventArgs e)
Parameters:eFilteringEventArgs

FilterOperatorsLoading(FilterOperatorsLoadingEventArgs)

The method is invoked when the FilterOperators for a given column are being loaded.

C#
protected virtual void FilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)
Parameters:eFilterOperatorsLoadingEventArgs

InsertItemInSource()

Inserts a new item in source.

C#
protected virtual void InsertItemInSource()

IsColumnReadOnly(int)

Determines whether a given column is ReadOnly.

C#
protected virtual bool IsColumnReadOnly(int columnIndex)
Parameters:columnIndexintReturns:

bool

OnCellEditEnded(CellEditEndedEventArgs)

Invoked by RadVirtualGrid when the CellEditEnded event is raised.

C#
protected virtual void OnCellEditEnded(CellEditEndedEventArgs e)
Parameters:eCellEditEndedEventArgs

OnCellToolTipNeeded(VirtualGridCellToolTipEventArgs)

Invoked by RadVirtualGrid when the CellToolTipNeeded event is raised.

C#
protected virtual void OnCellToolTipNeeded(VirtualGridCellToolTipEventArgs valueEventArgs)
Parameters:valueEventArgsVirtualGridCellToolTipEventArgs

OnCellValueNeeded(CellValueEventArgs)

Invoked by RadVirtualGrid when the CellValueNeeded event is raised.

C#
protected virtual void OnCellValueNeeded(CellValueEventArgs valueEventArgs)
Parameters:valueEventArgsCellValueEventArgs

OnEditorNeeded(EditorNeededEventArgs)

Invoked by RadVirtualGrid when the EditorNeeded event is raised.

C#
protected virtual void OnEditorNeeded(EditorNeededEventArgs args)
Parameters:argsEditorNeededEventArgs

OnEditorValueChanged(CellValueEventArgs)

Invoked by RadVirtualGrid when the EditorValueChanged event is raised.

C#
protected virtual void OnEditorValueChanged(CellValueEventArgs args)
Parameters:argsCellValueEventArgs

OnFilteringCompleted()

The method is called when the filter operation is completed.

C#
protected virtual void OnFilteringCompleted()

OnHeaderValueNeeded(HeaderValueEventArgs)

Invoked by RadVirtualGrid when the HeaderValueNeeded event is raised.

C#
protected virtual void OnHeaderValueNeeded(HeaderValueEventArgs e)
Parameters:eHeaderValueEventArgs

OnSortingCompleted()

The method is called when the sort operation is completed.

C#
protected virtual void OnSortingCompleted()

PushCellValueToSource(int, int, object)

Invoked by RadVirtualGrid when the CellEditEnded event is raised.

C#
protected virtual void PushCellValueToSource(int rowIndex, int columnIndex, object value)
Parameters:rowIndexintcolumnIndexintvalueobject

RemoveAllColumnFilters()

Removes all column filters from the Source QCV.

C#
protected virtual void RemoveAllColumnFilters()

RemoveColumnFilter(ColumnFilterDescriptor)

Removes the given filter descriptor from the Source QCV.

C#
protected virtual void RemoveColumnFilter(ColumnFilterDescriptor descriptor)
Parameters:descriptorColumnFilterDescriptor

RemoveItemsFromSource(List<int>)

Removes items from source.

C#
protected virtual void RemoveItemsFromSource(List<int> indexesToDelete)
Parameters:indexesToDeleteList<int>

SortDescriptorPrepared(SortedEventArgs)

The method is called when the SortDescriptors are prepared and a sort operation will occur.

C#
protected virtual void SortDescriptorPrepared(SortedEventArgs e)
Parameters:eSortedEventArgs

SortDescriptorPreparing(SortingEventArgs)

The method is called when the SortDescriptors are being prepared.

C#
protected virtual void SortDescriptorPreparing(SortingEventArgs e)
Parameters:eSortingEventArgs
In this article
DefinitionConstructorsDataProvider(IEnumerable)PropertiesDistinctValuesLimitInitialColumnCountInitialRowCountItemPropertiesParentGridShouldPushEditValueToGridSourceMethodsApplyFilterDescriptor(ColumnFilterDescriptor)ApplySortDescriptor(ColumnSortDescriptor)CreateEditor(out FrameworkElement, out DependencyProperty, object, int)DataMemberNeeded(DataMemberEventArgs)DistinctValuesLoading(DistinctValuesLoadingEventArgs)FilterDescriptorsPrepared(FilteredEventArgs)FilterDescriptorsPreparing(FilteringEventArgs)FilterOperatorsLoading(FilterOperatorsLoadingEventArgs)InsertItemInSource()IsColumnReadOnly(int)OnCellEditEnded(CellEditEndedEventArgs)OnCellToolTipNeeded(VirtualGridCellToolTipEventArgs)OnCellValueNeeded(CellValueEventArgs)OnEditorNeeded(EditorNeededEventArgs)OnEditorValueChanged(CellValueEventArgs)OnFilteringCompleted()OnHeaderValueNeeded(HeaderValueEventArgs)OnSortingCompleted()PushCellValueToSource(int, int, object)RemoveAllColumnFilters()RemoveColumnFilter(ColumnFilterDescriptor)RemoveItemsFromSource(List<int>)SortDescriptorPrepared(SortedEventArgs)SortDescriptorPreparing(SortingEventArgs)
Not finding the help you need?
Contact Support