Class DataProvider

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

Inheritance
System.Object
DataProvider
Namespace: Telerik.Windows.Controls.VirtualGrid
Assembly: Telerik.Windows.Controls.VirtualGrid.dll

Syntax

public class DataProvider : Object

Constructors

DataProvider(IEnumerable)

Initializes a new instance of the DataProvider class.

Declaration
public DataProvider(IEnumerable source)
Parameters
System.Collections.IEnumerable source

The source.

Properties

DistinctValuesLimit

Gets or sets the maximum count of distinct values.

Declaration
public int DistinctValuesLimit { get; set; }
Property Value
System.Int32

InitialColumnCount

Represents the initial column count.

Declaration
protected virtual int InitialColumnCount { get; }
Property Value
System.Int32

InitialRowCount

Represents the initial row count.

Declaration
protected virtual int InitialRowCount { get; }
Property Value
System.Int32

ItemProperties

Gets the item properties.

Declaration
public virtual IList<ItemPropertyInfo> ItemProperties { get; }
Property Value
System.Collections.Generic.IList<System.ComponentModel.ItemPropertyInfo>

The item properties.

ParentGrid

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

Declaration
protected RadVirtualGrid ParentGrid { get; set; }
Property Value
RadVirtualGrid

ShouldPushEditValueToGrid

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

Declaration
protected virtual bool ShouldPushEditValueToGrid { get; }
Property Value
System.Boolean

Source

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

Declaration
protected QueryableCollectionView Source { get; set; }
Property Value
QueryableCollectionView

Methods

ApplyFilterDescriptor(ColumnFilterDescriptor)

Adds the filter descriptor to the Source QCV.

Declaration
protected virtual void ApplyFilterDescriptor(ColumnFilterDescriptor descriptor)
Parameters
ColumnFilterDescriptor descriptor

ApplySortDescriptor(ColumnSortDescriptor)

Adds the sort descriptor to the Source QCV.

Declaration
protected virtual void ApplySortDescriptor(ColumnSortDescriptor descriptor)
Parameters
ColumnSortDescriptor descriptor

CreateEditor(out FrameworkElement, out DependencyProperty, Object, Int32)

Creates an editor.

Declaration
protected virtual void CreateEditor(out FrameworkElement editor, out DependencyProperty editorProperty, object propertyValue, int columnIndex)
Parameters
System.Windows.FrameworkElement editor

System.Windows.DependencyProperty editorProperty

System.Object propertyValue

System.Int32 columnIndex

DataMemberNeeded(DataMemberEventArgs)

Assigns the DataMemberEventArgs properties based on the values in ItemProperties.

Declaration
protected virtual void DataMemberNeeded(DataMemberEventArgs e)
Parameters
DataMemberEventArgs e

DistinctValuesLoading(DistinctValuesLoadingEventArgs)

Initializes DistinctValuesLoadingEventArgs.ItemsSource based on ItemProperties value.

Declaration
protected virtual void DistinctValuesLoading(DistinctValuesLoadingEventArgs e)
Parameters
DistinctValuesLoadingEventArgs e

FilterDescriptorsPrepared(FilteredEventArgs)

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

Declaration
protected virtual void FilterDescriptorsPrepared(FilteredEventArgs e)
Parameters
FilteredEventArgs e

FilterDescriptorsPreparing(FilteringEventArgs)

The method is called when the FilterDescriptors are being prepared.

Declaration
protected virtual void FilterDescriptorsPreparing(FilteringEventArgs e)
Parameters
FilteringEventArgs e

FilterOperatorsLoading(FilterOperatorsLoadingEventArgs)

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

Declaration
protected virtual void FilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)
Parameters
FilterOperatorsLoadingEventArgs e

InsertItemInSource()

Inserts a new item in source.

Declaration
protected virtual void InsertItemInSource()

IsColumnReadOnly(Int32)

Determines whether a given column is ReadOnly.

Declaration
protected virtual bool IsColumnReadOnly(int columnIndex)
Parameters
System.Int32 columnIndex

Returns
System.Boolean

OnCellEditEnded(CellEditEndedEventArgs)

Invoked by RadVirtualGrid when the CellEditEnded event is raised.

Declaration
protected virtual void OnCellEditEnded(CellEditEndedEventArgs e)
Parameters
CellEditEndedEventArgs e

OnCellToolTipNeeded(VirtualGridCellToolTipEventArgs)

Invoked by RadVirtualGrid when the CellToolTipNeeded event is raised.

Declaration
protected virtual void OnCellToolTipNeeded(VirtualGridCellToolTipEventArgs valueEventArgs)
Parameters
VirtualGridCellToolTipEventArgs valueEventArgs

OnCellValueNeeded(CellValueEventArgs)

Invoked by RadVirtualGrid when the CellValueNeeded event is raised.

Declaration
protected virtual void OnCellValueNeeded(CellValueEventArgs valueEventArgs)
Parameters
CellValueEventArgs valueEventArgs

OnEditorNeeded(EditorNeededEventArgs)

Invoked by RadVirtualGrid when the EditorNeeded event is raised.

Declaration
protected virtual void OnEditorNeeded(EditorNeededEventArgs args)
Parameters
EditorNeededEventArgs args

OnEditorValueChanged(CellValueEventArgs)

Invoked by RadVirtualGrid when the EditorValueChanged event is raised.

Declaration
protected virtual void OnEditorValueChanged(CellValueEventArgs args)
Parameters
CellValueEventArgs args

OnFilteringCompleted()

The method is called when the filter operation is completed.

Declaration
protected virtual void OnFilteringCompleted()

OnHeaderValueNeeded(HeaderValueEventArgs)

Invoked by RadVirtualGrid when the HeaderValueNeeded event is raised.

Declaration
protected virtual void OnHeaderValueNeeded(HeaderValueEventArgs e)
Parameters
HeaderValueEventArgs e

OnSortingCompleted()

The method is called when the sort operation is completed.

Declaration
protected virtual void OnSortingCompleted()

PushCellValueToSource(Int32, Int32, Object)

Invoked by RadVirtualGrid when the CellEditEnded event is raised.

Declaration
protected virtual void PushCellValueToSource(int rowIndex, int columnIndex, object value)
Parameters
System.Int32 rowIndex

System.Int32 columnIndex

System.Object value

RemoveAllColumnFilters()

Removes all column filters from the Source QCV.

Declaration
protected virtual void RemoveAllColumnFilters()

RemoveColumnFilter(ColumnFilterDescriptor)

Removes the given filter descriptor from the Source QCV.

Declaration
protected virtual void RemoveColumnFilter(ColumnFilterDescriptor descriptor)
Parameters
ColumnFilterDescriptor descriptor

RemoveItemsFromSource(List<Int32>)

Removes items from source.

Declaration
protected virtual void RemoveItemsFromSource(List<int> indexesToDelete)
Parameters
System.Collections.Generic.List<System.Int32> indexesToDelete

SortDescriptorPrepared(SortedEventArgs)

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

Declaration
protected virtual void SortDescriptorPrepared(SortedEventArgs e)
Parameters
SortedEventArgs e

SortDescriptorPreparing(SortingEventArgs)

The method is called when the SortDescriptors are being prepared.

Declaration
protected virtual void SortDescriptorPreparing(SortingEventArgs e)
Parameters
SortingEventArgs e

Extension Methods