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

RadVirtualGrid

Class

Represents a tabular control that dynamically loads data, using a light-weight engine to display and modify it.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.VirtualGrid.dll

Syntax:
C#
[TelerikToolboxCategory("Data")]
public class RadVirtualGrid : Control

Inheritance: objectRadVirtualGrid

Constructors

RadVirtualGrid()

Initializes a new instance of the RadVirtualGrid class.

C#
public RadVirtualGrid()

Fields

ActionOnLostFocusProperty

DependencyProperty

Represents the ActionOnLostFocus dependency property.

C#
public static readonly DependencyProperty ActionOnLostFocusProperty

AlternationBrushProperty

DependencyProperty

Represents the AlternationBrush dependency property.

C#
public static readonly DependencyProperty AlternationBrushProperty

CanUserDeleteRowsProperty

DependencyProperty

Represents the CanUserDeleteRows dependency property.

C#
public static readonly DependencyProperty CanUserDeleteRowsProperty

CanUserEditProperty

DependencyProperty

Represents the CanUserEdit dependency property.

C#
public static readonly DependencyProperty CanUserEditProperty

CanUserFilterColumnsProperty

DependencyProperty

Represents the CanUserFilterColumns dependency property.

C#
public static readonly DependencyProperty CanUserFilterColumnsProperty

CanUserInsertRowsProperty

DependencyProperty

Represents the CanUserInsertRows dependency property.

C#
public static readonly DependencyProperty CanUserInsertRowsProperty

CanUserResizeColumnsProperty

DependencyProperty

Represents the CanUserResizeColumns dependency property.

C#
public static readonly DependencyProperty CanUserResizeColumnsProperty

CanUserResizeRowsProperty

DependencyProperty

Represents the CanUserResizeRows dependency property.

C#
public static readonly DependencyProperty CanUserResizeRowsProperty

CanUserSelectProperty

DependencyProperty

Represents the CanUserEdit dependency property.

C#
public static readonly DependencyProperty CanUserSelectProperty

CanUserSortColumnsProperty

DependencyProperty

Represents the CanUserSortColumns dependency property.

C#
public static readonly DependencyProperty CanUserSortColumnsProperty

CellPaddingProperty

DependencyProperty

Represents the CellPadding dependency property.

C#
public static readonly DependencyProperty CellPaddingProperty

CellTextAlignmentProperty

DependencyProperty

Represents the CellTextAlignment dependency property.

C#
public static readonly DependencyProperty CellTextAlignmentProperty

CellToolTipTemplateProperty

DependencyProperty

Identifies the CellToolTipTemplate dependency property.

C#
public static readonly DependencyProperty CellToolTipTemplateProperty

ClipboardCopyModeProperty

DependencyProperty

Represents the ClipboardCopyMode dependency property.

C#
public static readonly DependencyProperty ClipboardCopyModeProperty

ColumnAlternationCountProperty

DependencyProperty

Represents the ColumnAlternationCount dependency property.

C#
public static readonly DependencyProperty ColumnAlternationCountProperty

ColumnHeaderBackgroundProperty

DependencyProperty

Represents the ColumnHeaderBackground dependency property.

C#
public static readonly DependencyProperty ColumnHeaderBackgroundProperty

ColumnHeaderForegroundProperty

DependencyProperty

Represents the ColumnHeaderForeground dependency property.

C#
public static readonly DependencyProperty ColumnHeaderForegroundProperty

ColumnHeaderHeightProperty

DependencyProperty

Represents the ColumnHeaderHeight dependency property.

C#
public static readonly DependencyProperty ColumnHeaderHeightProperty

ColumnHeaderLinesBrushProperty

DependencyProperty

Represents the ColumnHeaderLinesBrush dependency property.

C#
public static readonly DependencyProperty ColumnHeaderLinesBrushProperty

ColumnWidthProperty

DependencyProperty

Represents the ColumnWidth dependency property.

C#
public static readonly DependencyProperty ColumnWidthProperty

CopiedEvent

RoutedEvent

Occurs after copying the RadVirtualGrid's selected cells to the Clipboard.

C#
public static readonly RoutedEvent CopiedEvent

CopyingCellClipboardContentEvent

RoutedEvent

Occurs on copying a cell to the Clipboard.

C#
public static readonly RoutedEvent CopyingCellClipboardContentEvent

CopyingEvent

RoutedEvent

Occurs on copying the RadVirtualGrid's selected cells to the Clipboard.

C#
public static readonly RoutedEvent CopyingEvent

CurrentCellStrokeProperty

DependencyProperty

Represents the CurrentCellStroke dependency property.

C#
public static readonly DependencyProperty CurrentCellStrokeProperty

DataProviderProperty

DependencyProperty

Represents the DataProvider dependency property.

C#
public static readonly DependencyProperty DataProviderProperty

EditTriggersProperty

DependencyProperty

Represents the EditTriggers dependency property.

C#
public static readonly DependencyProperty EditTriggersProperty

FilterIconBackgroundFilteredProperty

DependencyProperty

Represents the FilterIconBackgroundFiltered dependency property.

C#
public static readonly DependencyProperty FilterIconBackgroundFilteredProperty

FilterIconBackgroundProperty

DependencyProperty

Represents the FilterIconBackground dependency property.

C#
public static readonly DependencyProperty FilterIconBackgroundProperty

HorizontalLinesBrushProperty

DependencyProperty

Represents the HorizontalLinesBrush dependency property.

C#
public static readonly DependencyProperty HorizontalLinesBrushProperty

InitialColumnCountProperty

DependencyProperty

Represents the InitialColumnCount dependency property.

C#
public static readonly DependencyProperty InitialColumnCountProperty

InitialRowCountProperty

DependencyProperty

Represents the InitialRowCount dependency property.

C#
public static readonly DependencyProperty InitialRowCountProperty

IsFilterableProperty

DependencyProperty

Represents the IsFilterable dependency property.

C#
public static readonly DependencyProperty IsFilterableProperty

IsFilteringDeferredProperty

DependencyProperty

Represents the IsFilteringDeferred dependency property.

C#
public static readonly DependencyProperty IsFilteringDeferredProperty

IsSortableProperty

DependencyProperty

Represents the IsSortable dependency property.

C#
public static readonly DependencyProperty IsSortableProperty

LinesVisibilityProperty

DependencyProperty

Represents the LinesVisibility dependency property.

C#
public static readonly DependencyProperty LinesVisibilityProperty

MeasureTextOnRenderProperty

DependencyProperty

Represents the MeasureTextOnRender dependency property.

C#
public static readonly DependencyProperty MeasureTextOnRenderProperty

PinnedCellBackgroundProperty

DependencyProperty

Represents the PinnedCellBackground dependency property.

C#
public static readonly DependencyProperty PinnedCellBackgroundProperty

PinnedCellForegroundProperty

DependencyProperty

Represents the PinnedCellForeground dependency property.

C#
public static readonly DependencyProperty PinnedCellForegroundProperty

PinnedRowHeaderBackgroundProperty

DependencyProperty

Represents the PinnedRowHeaderBackground dependency property.

C#
public static readonly DependencyProperty PinnedRowHeaderBackgroundProperty

RowAlternationCountProperty

DependencyProperty

Represents the RowAlternationCount dependency property.

C#
public static readonly DependencyProperty RowAlternationCountProperty

RowHeaderBackgroundProperty

DependencyProperty

Represents the RowHeaderBackground dependency property.

C#
public static readonly DependencyProperty RowHeaderBackgroundProperty

RowHeaderForegroundProperty

DependencyProperty

Represents the RowHeaderForeground dependency property.

C#
public static readonly DependencyProperty RowHeaderForegroundProperty

RowHeaderLinesBrushProperty

DependencyProperty

Represents the RowHeaderLinesBrush dependency property.

C#
public static readonly DependencyProperty RowHeaderLinesBrushProperty

RowHeaderWidthProperty

DependencyProperty

Represents the RowHeaderWidth dependency property.

C#
public static readonly DependencyProperty RowHeaderWidthProperty

RowHeightProperty

DependencyProperty

Represents the RowHeight dependency property.

C#
public static readonly DependencyProperty RowHeightProperty

SelectedIndexProperty

DependencyProperty

Identifies the SelectedIndexProperty dependency property.

C#
public static readonly DependencyProperty SelectedIndexProperty

SelectionBrushProperty

DependencyProperty

Represents the SelectionBrush dependency property.

C#
public static readonly DependencyProperty SelectionBrushProperty

SelectionChangedEvent

RoutedEvent

Identifies the SelectionChanged routed event.

C#
public static readonly RoutedEvent SelectionChangedEvent

SelectionModeProperty

DependencyProperty

Identifies the SelectionModeProperty dependency property.

C#
public static readonly DependencyProperty SelectionModeProperty

SelectionUnitProperty

DependencyProperty

Identifies the SelectionUnitProperty dependency property.

C#
public static readonly DependencyProperty SelectionUnitProperty

ShouldCreateAutomationPeerProperty

DependencyProperty

Represents the ShouldCreateAutomationPeer dependency property.

C#
public static readonly DependencyProperty ShouldCreateAutomationPeerProperty

ShowCellToolTipProperty

DependencyProperty

Represents the ShowCellToolTip dependency property.

C#
public static readonly DependencyProperty ShowCellToolTipProperty

ShowDistinctFiltersProperty

DependencyProperty

Represents the ShowDistinctFilters dependency property.

C#
public static readonly DependencyProperty ShowDistinctFiltersProperty

ShowFieldFiltersProperty

DependencyProperty

Represents the ShowFieldFilters dependency property.

C#
public static readonly DependencyProperty ShowFieldFiltersProperty

SortedHeaderBackgroundProperty

DependencyProperty

Represents the SortedHeaderBackground dependency property.

C#
public static readonly DependencyProperty SortedHeaderBackgroundProperty

SortedHeaderForegroundProperty

DependencyProperty

Represents the SortedHeaderForeground dependency property.

C#
public static readonly DependencyProperty SortedHeaderForegroundProperty

SortIconBackgroundProperty

DependencyProperty

Represents the SortIndicatorBackground dependency property.

C#
public static readonly DependencyProperty SortIconBackgroundProperty

VerticalLinesBrushProperty

DependencyProperty

Represents the VerticalLinesBrush dependency property.

C#
public static readonly DependencyProperty VerticalLinesBrushProperty

Properties

ActionOnLostFocus

Gets or sets the action to take when an element of the RadVirtualGrid loses focus.

C#
public ActionOnLostFocus ActionOnLostFocus { get; set; }
Property Value:

The action to take when an element of the RadVirtualGrid loses focus.

AlternationBrush

Brush

Get or sets the alternation color.

C#
public Brush AlternationBrush { get; set; }

CanUserDeleteRows

Gets or sets a value that indicates whether the user can delete rows.

C#
public bool CanUserDeleteRows { get; set; }
Property Value:

true if the user can add new rows; otherwise, false. The registered default is true.

CanUserEdit

Gets or sets a value that indicates whether data can be modified through user input.

C#
public bool CanUserEdit { get; set; }
Property Value:

The can user edit.

CanUserFilterColumns

Gets or sets a value that indicates whether users can filter columns through the UI.

C#
public bool CanUserFilterColumns { get; set; }

CanUserInsertRows

Gets or sets a value that indicates whether the user can add new rows.

C#
public bool CanUserInsertRows { get; set; }
Property Value:

true if the user can add new rows; otherwise, false. The registered default is true.

CanUserResizeColumns

Gets or sets a value that indicates whether users can resize columns through the UI.

C#
public bool CanUserResizeColumns { get; set; }

CanUserResizeRows

Gets or sets a value that indicates whether users can resize rows through the UI.

C#
public bool CanUserResizeRows { get; set; }

CanUserSelect

Gets or sets a value that indicates whether a user can select rows or cells.

C#
public bool CanUserSelect { get; set; }
Property Value:

The can user edit.

CanUserSortColumns

Gets or sets a value that indicates whether users can sort columns through the UI.

C#
public bool CanUserSortColumns { get; set; }

CellPadding

Thickness

Gets or sets a value that indicates the cells' text padding.

C#
public Thickness CellPadding { get; set; }

CellTextAlignment

TextAlignment

Gets or sets the text alignment.

C#
public TextAlignment CellTextAlignment { get; set; }

CellToolTipTemplate

DataTemplate

Gets or sets the ContentTemplate of the tooltip that is shown for RadVirtualGrid cells.

C#
public DataTemplate CellToolTipTemplate { get; set; }

ClipboardCopyMode

Gets or sets a value that indicates how data is copied to the clipboard.

C#
public VirtualGridClipboardCopyMode ClipboardCopyMode { get; set; }
Remarks:

Use this property to specify whether a user can copy RadVirtualGrid content to the clipboard.

ColumnAlternationCount

Gets or sets the alternation step for columns.

C#
public int ColumnAlternationCount { get; set; }

ColumnHeaderBackground

Brush

Gets or sets the column headers' background.

C#
public Brush ColumnHeaderBackground { get; set; }

ColumnHeaderForeground

Brush

Gets or sets the column headers' foreground.

C#
public Brush ColumnHeaderForeground { get; set; }

ColumnHeaderHeight

Gets or sets the height of the column headers.

C#
public double ColumnHeaderHeight { get; set; }

ColumnHeaderLinesBrush

Brush

Gets or sets the column header lines' stroke brush.

C#
public Brush ColumnHeaderLinesBrush { get; set; }

ColumnWidth

Gets or sets the width of the columns.

C#
public double ColumnWidth { get; set; }

CurrentCellInfo

Gets or sets the current cell info.

C#
public VirtualGridCellInfo CurrentCellInfo { get; set; }
Property Value:

The current cell info.

CurrentCellStroke

Brush

Gets or sets the stroke brush of the current cell.

C#
public Brush CurrentCellStroke { get; set; }

DataProvider

Gets or sets the data provider.

C#
public DataProvider DataProvider { get; set; }

EditTriggers

Gets or sets the edit triggers.

C#
public VirtualGridEditTriggers EditTriggers { get; set; }
Property Value:

The edit triggers.

FilterIconBackground

Brush

Gets or sets the filter icon background brush.

C#
public Brush FilterIconBackground { get; set; }

FilterIconBackgroundFiltered

Brush

Gets or sets the filter icon background brush when the column is filtered.

C#
public Brush FilterIconBackgroundFiltered { get; set; }

HorizontalLinesBrush

Brush

Gets or sets the horizontal lines' stroke brush.

C#
public Brush HorizontalLinesBrush { get; set; }

InitialColumnCount

Gets or sets the initial column count.

C#
public int InitialColumnCount { get; set; }

InitialRowCount

Gets or sets the initial row count.

C#
public int InitialRowCount { get; set; }

IsFilterable

Gets or sets a value that indicates whether programmatic and UI filtering is possible.

C#
public bool IsFilterable { get; set; }

IsFilteringDeferred

Gets or sets a value that indicates whether deferred filtering is enabled.

C#
public bool IsFilteringDeferred { get; set; }

IsSortable

Gets or sets a value that indicates whether programmatic and UI sorting is possible.

C#
public bool IsSortable { get; set; }

KeyboardCommandProvider

Gets the keyboard command provider.

C#
public IKeyboardCommandProvider KeyboardCommandProvider { get; set; }
Property Value:

The keyboard command provider. This class provides command key mappings.

LinesVisibility

Gets or sets the lines' visibility.

C#
public VirtualGridLinesVisibility LinesVisibility { get; set; }

MeasureTextOnRender

Gets or sets a value that indicates whether text is measured when rendering. Setting it to true enables changing TextAlignment and FitColumnWidthToContent. It may affect rendering performance.

C#
public bool MeasureTextOnRender { get; set; }

PendingCommands

Gets all pending commands.

C#
public List<ICommand> PendingCommands { get; }
Property Value:

The pending commands.

PinnedCellBackground

Brush

Gets or sets the cells' background when cells are pinned.

C#
public Brush PinnedCellBackground { get; set; }

PinnedCellForeground

Brush

Gets or sets the cells' foreground when cells are pinned.

C#
public Brush PinnedCellForeground { get; set; }

PinnedRowHeaderBackground

Brush

Gets or sets the pinned row headers' background.

C#
public Brush PinnedRowHeaderBackground { get; set; }

RowAlternationCount

Gets or sets the alternation step for rows.

C#
public int RowAlternationCount { get; set; }

RowHeaderBackground

Brush

Gets or sets the row headers' background.

C#
public Brush RowHeaderBackground { get; set; }

RowHeaderForeground

Brush

Gets or sets the row header's foreground.

C#
public Brush RowHeaderForeground { get; set; }

RowHeaderLinesBrush

Brush

Gets or sets the row header lines' stroke brush.

C#
public Brush RowHeaderLinesBrush { get; set; }

RowHeaderWidth

Gets or sets the width of the row headers.

C#
public double RowHeaderWidth { get; set; }

RowHeight

Gets or sets the height of the rows.

C#
public double RowHeight { get; set; }

SelectedCells

Gets the selected cells.

C#
public IList<VirtualGridCellInfo> SelectedCells { get; }

SelectedIndex

Gets or sets the selected index of RadVirtualGrid.

C#
public int SelectedIndex { get; set; }

SelectedIndexes

Gets the selected indexes.

C#
public IEnumerable<int> SelectedIndexes { get; }

SelectionBrush

Brush

Gets or sets a value that indicates the selection brush.

C#
public Brush SelectionBrush { get; set; }

SelectionMode

SelectionMode

Gets or sets the selection mode of the VirtualGrid. The default value is System.Windows.Controls.SelectionMode.

C#
public SelectionMode SelectionMode { get; set; }

SelectionUnit

Gets or sets the selection unit of the VirtualGrid. The default value is VirtualGridSelectionUnit.FullRow

C#
public VirtualGridSelectionUnit SelectionUnit { get; set; }

ShouldCreateAutomationPeer

Gets or sets a value indicating whether automation peers for the RadVirtualGrid should be created.

C#
public bool ShouldCreateAutomationPeer { get; set; }
Remarks:

The default value of this property is False which will stop RadVirtualGrid from creating child automation peers for each of the visible cells. This may increase performance and decrease memory consumption on some touch-enabled computers, where the automation tree is created on application startup.

ShowCellToolTip

Gets or sets a value indicating whether a tooltip will be shown for RadVirtualGrid cells.

C#
public bool ShowCellToolTip { get; set; }

ShowDistinctFilters

Gets or sets a value that indicates whether distinct filters are visible.

C#
public bool ShowDistinctFilters { get; set; }

ShowFieldFilters

Gets or sets a value that indicates whether filed filters are visible.

C#
public bool ShowFieldFilters { get; set; }

SortedHeaderBackground

Brush

Gets or sets the headers' background when the respective columns are sorted.

C#
public Brush SortedHeaderBackground { get; set; }

SortedHeaderForeground

Brush

Gets or sets the headers' foreground when the respective columns are sorted.

C#
public Brush SortedHeaderForeground { get; set; }

SortIconBackground

Brush

Gets or sets a value that indicates the background of the sort icon.

C#
public Brush SortIconBackground { get; set; }

VerticalLinesBrush

Brush

Gets or sets the vertical lines' stroke brush.

C#
public Brush VerticalLinesBrush { get; set; }

Methods

ApplyFilterDescriptorChanges(ColumnFilterDescriptor)

Propagates filter descriptor changes.

C#
protected virtual void ApplyFilterDescriptorChanges(ColumnFilterDescriptor filterDescriptor)
Parameters:filterDescriptorColumnFilterDescriptor

BeginEdit(int, int)

Causes the RadVirtualGrid to enter editing mode for a given cell coordinates, unless the data grid is already in editing mode.

C#
public void BeginEdit(int rowIndex, int columnIndex)
Parameters:rowIndexintcolumnIndexint

BeginInsert()

Causes the RadVirtualGrid to show new row and enter into EditMode.

C#
public void BeginInsert()

CallFiltered(IEnumerable<IFilterDescriptor>, IEnumerable<IFilterDescriptor>, int)

Generates FilteredEventArgs and invokes the FilterDescriptorPrepared event.

C#
protected virtual void CallFiltered(IEnumerable<IFilterDescriptor> added, IEnumerable<IFilterDescriptor> removed, int columnIndex)
Parameters:addedIEnumerable<IFilterDescriptor>removedIEnumerable<IFilterDescriptor>columnIndexint

CallFiltering(IEnumerable<IFilterDescriptor>, IEnumerable<IFilterDescriptor>, int)

Generates FilteringEventArgs and invokes the FilterDescriptorPreparing event.

C#
protected virtual bool CallFiltering(IEnumerable<IFilterDescriptor> added, IEnumerable<IFilterDescriptor> removed, int columnIndex)
Parameters:addedIEnumerable<IFilterDescriptor>removedIEnumerable<IFilterDescriptor>columnIndexintReturns:

bool

CancelEdit()

Causes the data grid to cancel the current edit, restore the original value, and exit editing mode.

C#
public void CancelEdit()

ClearColumnFilters()

Clears all existing column filters.

C#
public virtual void ClearColumnFilters()

ClearFiltersForColumn(int)

Clears the filter descriptors for the given column and resets its filtering control.

C#
public virtual void ClearFiltersForColumn(int columnIndex)
Parameters:columnIndexint

CloseFilteringControl()

Closes the filtering UI.

C#
public void CloseFilteringControl()

CommitEdit()

Commits the edit.

C#
public void CommitEdit()

CopyToClipboard()

Copies RadVirtualGrid selected cells to clipboard.

C#
public void CopyToClipboard()

ExecutePendingCommand()

Executes all pending commands in a sequence.

C#
public void ExecutePendingCommand()

FilterColumn(int)

Invokes the filtering UI for a specific column.

C#
public void FilterColumn(int columnIndex)
Parameters:columnIndexint

FitColumnWidthToContent(int)

Set column width to be as large as the biggest cell's content, if the MeasureTextOnRender property is set to True.

C#
public double FitColumnWidthToContent(int columnIndex)
Parameters:columnIndexintReturns:

double

The calculated column width, if the MeasureTextOnRender property is set to True; otherwise, 0.0.

GetAvailableOperatorsForType(Type)

List<FilterOperator>

Retrieves the list of available FilterOperators for a given type.

C#
protected virtual List<FilterOperator> GetAvailableOperatorsForType(Type dataType)
Parameters:dataTypeTypeReturns:

List<FilterOperator>

GetColumnIndexAtMousePosition(CanvasInputBorder)

Returns the index of a column for a given mouse position.

C#
public int GetColumnIndexAtMousePosition(CanvasInputBorder canvasInputBorder)
Parameters:canvasInputBorderCanvasInputBorderReturns:

int

GetFilterDescriptorForColumn(int)

Gets the ColumnFilterDescriptor for a specific column.

C#
public ColumnFilterDescriptor GetFilterDescriptorForColumn(int columnIndex)
Parameters:columnIndexintReturns:

ColumnFilterDescriptor

GetFilteringControlForColumn(int)

Gets the FilteringControl for a specific column.

C#
public FilteringControl GetFilteringControlForColumn(int columnIndex)
Parameters:columnIndexintReturns:

FilteringControl

GetRowIndexAtMousePosition(CanvasInputBorder)

Returns the index of a row for a given mouse position.

C#
public int GetRowIndexAtMousePosition(CanvasInputBorder canvasInputBorder)
Parameters:canvasInputBorderCanvasInputBorderReturns:

int

GetSortDescriptorForColumn(int)

Gets the ColumnSortDescriptor for a specific column.

C#
public ColumnSortDescriptor GetSortDescriptorForColumn(int columnIndex)
Parameters:columnIndexintReturns:

ColumnSortDescriptor

InsertNewColumnAtIndex(int)

Increases the table capacity by adding a column on the given index.

C#
public void InsertNewColumnAtIndex(int index)
Parameters:indexint

InsertNewRowAtIndex(int)

Increases the table capacity by adding a row on the given index.

C#
public void InsertNewRowAtIndex(int index)
Parameters:indexint

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call .

C#
public override void OnApplyTemplate()

OnCreateAutomationPeer()

AutomationPeer

Returns an automation peer for RadVirtualGrid.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

OnDistinctValuesLoading(DistinctValuesLoadingEventArgs)

Invoked DataProvider.DistinctValuesLoading if DataProvider is available, or raises DistinctValuesLoading instead.

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

OnFieldFilterEditorCreated(FieldFilterEditorCreatedEventArgs)

C#
protected virtual void OnFieldFilterEditorCreated(FieldFilterEditorCreatedEventArgs args)
Parameters:argsFieldFilterEditorCreatedEventArgs

OnFiltered(FilteredEventArgs)

Invokes the FilterDescriptorPrepared event.

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

OnFiltering(FilteringEventArgs)

Invokes the FilterDescriptorsPreparing event.

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

OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs)

Invokes DataProvider.FilterOperatorsLoading if DataProvider is available or raises FilterOperatorsLoading instead.

C#
protected void OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)
Parameters:eFilterOperatorsLoadingEventArgs

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

OnPreviewKeyDown(KeyEventArgs)

Occurs when KeyDown event is raised.

C#
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

OnSelectedCellsChanging(VirtualGridSelectedCellsChangingEventArgs)

Raises the SelectedCellsChangingEvent event.

C#
protected virtual void OnSelectedCellsChanging(VirtualGridSelectedCellsChangingEventArgs args)
Parameters:argsVirtualGridSelectedCellsChangingEventArgs

The VirtualGridSelectedCellsChangingEventArgs instance containing the event data.

OnSorted(SortedEventArgs)

Invokes DataProvider.SortDescriptorPreparing if DataProvider is present or invokes the SortDescriptorPreparing event instead.

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

OnSorting(SortingEventArgs)

Invokes DataProvider.SortDescriptorPreparing if DataProvider is present or invokes the SortDescriptorPreparing event instead.

C#
protected virtual void OnSorting(SortingEventArgs e)
Parameters:eSortingEventArgs

OnTextInput(TextCompositionEventArgs)

Executed when text has been input.

C#
protected override void OnTextInput(TextCompositionEventArgs e)
Parameters:eTextCompositionEventArgs

Event args.

PinColumnLeft(int)

Pins the column left.

C#
public void PinColumnLeft(int columnIndex)
Parameters:columnIndexint

PinColumnRight(int)

Pins the column right.

C#
public void PinColumnRight(int columnIndex)
Parameters:columnIndexint

PinRowBottom(int)

Pins the row bottom.

C#
public void PinRowBottom(int rowIndex)
Parameters:rowIndexint

PinRowTop(int)

Pins the row top.

C#
public void PinRowTop(int rowIndex)
Parameters:rowIndexint

PushCellValue(int, int, object)

Updates VirtualGrid with the given value. It also needs to be persisted in the data source.

C#
public void PushCellValue(int rowIndex, int columnIndex, object value)
Parameters:rowIndexintcolumnIndexintvalueobject

RemoveColumnAtIndex(int)

Reduces the table capacity by removing a column on the given index.

C#
public void RemoveColumnAtIndex(int index)
Parameters:indexint

RemoveRowAtIndex(int)

Reduces the table capacity by removing a row on the given index.

C#
public void RemoveRowAtIndex(int index)
Parameters:indexint

Reset()

Resets the control to its initial visual state.

C#
public void Reset()

Reset(int, int)

Resets the control to an initial visual state with the given row count and column count.

C#
public void Reset(int rowCount, int columnCount)
Parameters:rowCountintcolumnCountint

ResetTheme()

Resets the theme.

C#
public void ResetTheme()

ScrollColumnIndexIntoViewAsync(int, Action, Action)

Scrolls the column with the specified index into view in an asynchronous manner.

C#
public void ScrollColumnIndexIntoViewAsync(int columnIndex, Action scrollFinishedCallback, Action scrollFailedCallback)
Parameters:columnIndexint

The column index to scroll into view.

scrollFinishedCallbackAction

The method to execute when scrolling has finished.

scrollFailedCallbackAction

The method to execute when scrolling has failed.

Remarks:

Since this method is asynchronous, calling it will return immediately. If you need to perform a certain action once the scrolling is done use the scrollFinishedCallback parameter to pass in a method to execute. The FrameworkElement parameter of this method will be the column that was just scrolled.

ScrollIndexIntoViewAsync(int, int, Action, Action)

Scrolls the row with the specified index and column into view in an asynchronous manner.

C#
public void ScrollIndexIntoViewAsync(int rowIndex, int columnIndex, Action scrollFinishedCallback, Action scrollFailedCallback)
Parameters:rowIndexint

The row index to scroll into view.

columnIndexint

The column index to scroll into view.

scrollFinishedCallbackAction

The method to execute when scrolling has finished.

scrollFailedCallbackAction

The method to execute when scrolling has failed.

Remarks:

Since this method is asynchronous, calling it will return immediately. If you need to perform a certain action once the scrolling is done use the scrollFinishedCallback method.

ScrollRowIndexIntoViewAsync(int, Action, Action)

Scrolls the row with the specified index into view in an asynchronous manner.

C#
public void ScrollRowIndexIntoViewAsync(int rowIndex, Action scrollFinishedCallback, Action scrollFailedCallback)
Parameters:rowIndexint

The row index to scroll into view.

scrollFinishedCallbackAction

The method to execute when scrolling has finished.

scrollFailedCallbackAction

The method to execute when scrolling has failed.

Remarks:

Since this method is asynchronous, calling it will return immediately. If you need to perform a certain action once the scrolling is done use the scrollFinishedCallback parameter to pass in a method to execute. The FrameworkElement parameter of this method will be the row that was just scrolled.

SelectAll()

Selects all the items as defined by the SelectionMode and SelectionUnit

C#
public void SelectAll()

SelectCellRegion(CellRegion)

Selects specified region of cells.

C#
public void SelectCellRegion(CellRegion cellRegion)
Parameters:cellRegionCellRegion

SelectCellRegion(IEnumerable<CellRegion>)

Selects specified region of cells.

C#
public void SelectCellRegion(IEnumerable<CellRegion> cellRegions)
Parameters:cellRegionsIEnumerable<CellRegion>

SortColumn(int)

Invokes the sorting UI for a specific column.

C#
public void SortColumn(int columnIndex)
Parameters:columnIndexint

ToggleIndexSelection(int)

Selects the given index if it is not selected, or deselects if it is already selected.

C#
public void ToggleIndexSelection(int index)
Parameters:indexint

UnpinColumn(int)

Unpins the column with the given index.

C#
public void UnpinColumn(int columnIndex)
Parameters:columnIndexint

UnpinRow(int)

Unpins the row with the given index.

C#
public void UnpinRow(int rowIndex)
Parameters:rowIndexint

UnselectAll()

Clears the current selection state.

C#
public void UnselectAll()

UnselectCellRegion(CellRegion)

Deselects specified region of cells.

C#
public void UnselectCellRegion(CellRegion cellRegion)
Parameters:cellRegionCellRegion

UnselectCellRegion(IEnumerable<CellRegion>)

Deselects specified region of cells.

C#
public void UnselectCellRegion(IEnumerable<CellRegion> cellRegions)
Parameters:cellRegionsIEnumerable<CellRegion>

UpdateHeadersUI()

Update on the row and column headers' UI, taking into account visual properties changes.

C#
public void UpdateHeadersUI()

UpdateUI()

Update on the UI, taking into account visual properties changes.

C#
public void UpdateUI()

Events

CellDecorationsNeeded

Occurs when a cell will be visualized. Setting the arguments' properties will visually modify the cell.

C#
public event EventHandler<CellDecorationEventArgs> CellDecorationsNeeded

CellEditEnded

Occurs when an edit operation is finished.

C#
public event EventHandler<CellEditEndedEventArgs> CellEditEnded

CellTemplateNeeded

Occurs when RadVirtualGrid fetches the DataTemplate for a given cell.

C#
public event EventHandler<CellTemplateEventArgs> CellTemplateNeeded

CellToolTipNeeded

Occurs when RadVirtualGrid fetches the value for a cell's tooltip.

C#
public event EventHandler<VirtualGridCellToolTipEventArgs> CellToolTipNeeded

CellValueNeeded

Occurs when RadVirtualGrid fetches the value for a cell.

C#
public event EventHandler<CellValueEventArgs> CellValueNeeded

Copied

Occurs after the selected cells of the RadVirtualGrid were copied to the Clipboard.

C#
public event EventHandler<RadRoutedEventArgs> Copied

Copying

Occurs before the selected cells of the RadVirtualGrid are copied to the Clipboard.

C#
public event EventHandler<VirtualGridClipboardEventArgs> Copying

CopyingCellClipboardContent

Occurs before a cell is copied to the Clipboard.

C#
public event EventHandler<VirtualGridCellClipboardEventArgs> CopyingCellClipboardContent

CurrentCellChanged

Occurs when the current cell is changed.

C#
public event EventHandler<VirtualGridCurrentCellChangedEventArgs> CurrentCellChanged

DataMemberNeeded

Occurs when data-related information for a given column is needed.

C#
public event EventHandler<DataMemberEventArgs> DataMemberNeeded

Deleted

Occurs when VirtualGrid's selected indexes are deleted.

C#
public event EventHandler<VirtualGridDeletedEventArgs> Deleted

Deleting

Occurs when deleting the VirtualGrid's selected indexes.

C#
public event EventHandler<VirtualGridDeletingEventArgs> Deleting

DistinctValuesLoading

Occurs when distinct values are being loaded.

C#
public event EventHandler<DistinctValuesLoadingEventArgs> DistinctValuesLoading

EditorNeeded

Occurs when a cell is edited and the editor property value gets changed.

C#
public event EventHandler<EditorNeededEventArgs> EditorNeeded

EditorValueChanged

Occurs when a cell is edited and an editor is required.

C#
public event EventHandler<CellValueEventArgs> EditorValueChanged

FieldFilterEditorCreated

Occurs when filed filter editor is created.

C#
public event EventHandler<FieldFilterEditorCreatedEventArgs> FieldFilterEditorCreated

FilterDescriptorsPrepared

Occurs when filter descriptors for the filtered column are ready and filtering operation will be executed.

C#
public event EventHandler<FilteredEventArgs> FilterDescriptorsPrepared

FilterDescriptorsPreparing

Occurs when filter descriptors for the filtered column are being prepared.

C#
public event EventHandler<FilteringEventArgs> FilterDescriptorsPreparing

FilterOperatorsLoading

Occurs when filter operators are being loaded.

C#
public event EventHandler<FilterOperatorsLoadingEventArgs> FilterOperatorsLoading

HeaderCellDecorationsNeeded

Occurs when a header cell will be visualized. Setting the arguments' properties will visually modify the header cell.

C#
public event EventHandler<HeaderCellDecorationEventArgs> HeaderCellDecorationsNeeded

HeaderSizeNeeded

Occurs when size for a header cell is needed.

C#
public event EventHandler<HeaderSizeEventArgs> HeaderSizeNeeded

HeaderValueNeeded

Occurs when header cell values is needed.

C#
public event EventHandler<HeaderValueEventArgs> HeaderValueNeeded

OverlayBrushesNeeded

Occurs when the set of brushes that will be used for background customization is needed.

C#
public event EventHandler<OverlayBrushesEventArgs> OverlayBrushesNeeded

SelectedCellsChanged

Event that fires when the SelectedCells collection is changed.

C#
public event EventHandler<VirtualGridSelectedCellsChangedEventArgs> SelectedCellsChanged

SelectedCellsChanging

Event that fires when the SelectedCells collection is about to change.

C#
public event EventHandler<VirtualGridSelectedCellsChangingEventArgs> SelectedCellsChanging

SelectionChanged

SelectionChangedEventHandler

Event that fires when the selection of RadVirtualGrid is changed.

C#
public event SelectionChangedEventHandler SelectionChanged

SortDescriptorPrepared

Occurs when sort descriptors for the sorted column is ready and sorting operation will be executed.

C#
public event EventHandler<SortedEventArgs> SortDescriptorPrepared

SortDescriptorPreparing

Occurs when sort descriptor for the sorted column is being prepared.

C#
public event EventHandler<SortingEventArgs> SortDescriptorPreparing
In this article
DefinitionConstructorsRadVirtualGrid()FieldsActionOnLostFocusPropertyAlternationBrushPropertyCanUserDeleteRowsPropertyCanUserEditPropertyCanUserFilterColumnsPropertyCanUserInsertRowsPropertyCanUserResizeColumnsPropertyCanUserResizeRowsPropertyCanUserSelectPropertyCanUserSortColumnsPropertyCellPaddingPropertyCellTextAlignmentPropertyCellToolTipTemplatePropertyClipboardCopyModePropertyColumnAlternationCountPropertyColumnHeaderBackgroundPropertyColumnHeaderForegroundPropertyColumnHeaderHeightPropertyColumnHeaderLinesBrushPropertyColumnWidthPropertyCopiedEventCopyingCellClipboardContentEventCopyingEventCurrentCellStrokePropertyDataProviderPropertyEditTriggersPropertyFilterIconBackgroundFilteredPropertyFilterIconBackgroundPropertyHorizontalLinesBrushPropertyInitialColumnCountPropertyInitialRowCountPropertyIsFilterablePropertyIsFilteringDeferredPropertyIsSortablePropertyLinesVisibilityPropertyMeasureTextOnRenderPropertyPinnedCellBackgroundPropertyPinnedCellForegroundPropertyPinnedRowHeaderBackgroundPropertyRowAlternationCountPropertyRowHeaderBackgroundPropertyRowHeaderForegroundPropertyRowHeaderLinesBrushPropertyRowHeaderWidthPropertyRowHeightPropertySelectedIndexPropertySelectionBrushPropertySelectionChangedEventSelectionModePropertySelectionUnitPropertyShouldCreateAutomationPeerPropertyShowCellToolTipPropertyShowDistinctFiltersPropertyShowFieldFiltersPropertySortedHeaderBackgroundPropertySortedHeaderForegroundPropertySortIconBackgroundPropertyVerticalLinesBrushPropertyPropertiesActionOnLostFocusAlternationBrushCanUserDeleteRowsCanUserEditCanUserFilterColumnsCanUserInsertRowsCanUserResizeColumnsCanUserResizeRowsCanUserSelectCanUserSortColumnsCellPaddingCellTextAlignmentCellToolTipTemplateClipboardCopyModeColumnAlternationCountColumnHeaderBackgroundColumnHeaderForegroundColumnHeaderHeightColumnHeaderLinesBrushColumnWidthCurrentCellInfoCurrentCellStrokeDataProviderEditTriggersFilterIconBackgroundFilterIconBackgroundFilteredHorizontalLinesBrushInitialColumnCountInitialRowCountIsFilterableIsFilteringDeferredIsSortableKeyboardCommandProviderLinesVisibilityMeasureTextOnRenderPendingCommandsPinnedCellBackgroundPinnedCellForegroundPinnedRowHeaderBackgroundRowAlternationCountRowHeaderBackgroundRowHeaderForegroundRowHeaderLinesBrushRowHeaderWidthRowHeightSelectedCellsSelectedIndexSelectedIndexesSelectionBrushSelectionModeSelectionUnitShouldCreateAutomationPeerShowCellToolTipShowDistinctFiltersShowFieldFiltersSortedHeaderBackgroundSortedHeaderForegroundSortIconBackgroundVerticalLinesBrushMethodsApplyFilterDescriptorChanges(ColumnFilterDescriptor)BeginEdit(int, int)BeginInsert()CallFiltered(IEnumerable<IFilterDescriptor>, IEnumerable<IFilterDescriptor>, int)CallFiltering(IEnumerable<IFilterDescriptor>, IEnumerable<IFilterDescriptor>, int)CancelEdit()ClearColumnFilters()ClearFiltersForColumn(int)CloseFilteringControl()CommitEdit()CopyToClipboard()ExecutePendingCommand()FilterColumn(int)FitColumnWidthToContent(int)GetAvailableOperatorsForType(Type)GetColumnIndexAtMousePosition(CanvasInputBorder)GetFilterDescriptorForColumn(int)GetFilteringControlForColumn(int)GetRowIndexAtMousePosition(CanvasInputBorder)GetSortDescriptorForColumn(int)InsertNewColumnAtIndex(int)InsertNewRowAtIndex(int)OnApplyTemplate()OnCreateAutomationPeer()OnDistinctValuesLoading(DistinctValuesLoadingEventArgs)OnFieldFilterEditorCreated(FieldFilterEditorCreatedEventArgs)OnFiltered(FilteredEventArgs)OnFiltering(FilteringEventArgs)OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs)OnInitialized(EventArgs)OnPreviewKeyDown(KeyEventArgs)OnSelectedCellsChanging(VirtualGridSelectedCellsChangingEventArgs)OnSorted(SortedEventArgs)OnSorting(SortingEventArgs)OnTextInput(TextCompositionEventArgs)PinColumnLeft(int)PinColumnRight(int)PinRowBottom(int)PinRowTop(int)PushCellValue(int, int, object)RemoveColumnAtIndex(int)RemoveRowAtIndex(int)Reset()Reset(int, int)ResetTheme()ScrollColumnIndexIntoViewAsync(int, Action, Action)ScrollIndexIntoViewAsync(int, int, Action, Action)ScrollRowIndexIntoViewAsync(int, Action, Action)SelectAll()SelectCellRegion(CellRegion)SelectCellRegion(IEnumerable<CellRegion>)SortColumn(int)ToggleIndexSelection(int)UnpinColumn(int)UnpinRow(int)UnselectAll()UnselectCellRegion(CellRegion)UnselectCellRegion(IEnumerable<CellRegion>)UpdateHeadersUI()UpdateUI()EventsCellDecorationsNeededCellEditEndedCellTemplateNeededCellToolTipNeededCellValueNeededCopiedCopyingCopyingCellClipboardContentCurrentCellChangedDataMemberNeededDeletedDeletingDistinctValuesLoadingEditorNeededEditorValueChangedFieldFilterEditorCreatedFilterDescriptorsPreparedFilterDescriptorsPreparingFilterOperatorsLoadingHeaderCellDecorationsNeededHeaderSizeNeededHeaderValueNeededOverlayBrushesNeededSelectedCellsChangedSelectedCellsChangingSelectionChangedSortDescriptorPreparedSortDescriptorPreparing
Not finding the help you need?
Contact Support