Class RadVirtualGrid

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

Inheritance

System.Object

RadVirtualGrid

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.VirtualGrid.dll

Syntax

[TelerikToolboxCategory("Data")]
public class RadVirtualGrid : Control, IThemable

Constructors

RadVirtualGrid()

Initializes a new instance of the RadVirtualGrid class.

Declaration

public RadVirtualGrid()

Fields

ActionOnLostFocusProperty

Represents the ActionOnLostFocus dependency property.

Declaration

public static readonly DependencyProperty ActionOnLostFocusProperty

Field Value

System.Windows.DependencyProperty

AlternationBrushProperty

Represents the AlternationBrush dependency property.

Declaration

public static readonly DependencyProperty AlternationBrushProperty

Field Value

System.Windows.DependencyProperty

CanUserDeleteRowsProperty

Represents the CanUserDeleteRows dependency property.

Declaration

public static readonly DependencyProperty CanUserDeleteRowsProperty

Field Value

System.Windows.DependencyProperty

CanUserEditProperty

Represents the CanUserEdit dependency property.

Declaration

public static readonly DependencyProperty CanUserEditProperty

Field Value

System.Windows.DependencyProperty

CanUserFilterColumnsProperty

Represents the CanUserFilterColumns dependency property.

Declaration

public static readonly DependencyProperty CanUserFilterColumnsProperty

Field Value

System.Windows.DependencyProperty

CanUserInsertRowsProperty

Represents the CanUserInsertRows dependency property.

Declaration

public static readonly DependencyProperty CanUserInsertRowsProperty

Field Value

System.Windows.DependencyProperty

CanUserResizeColumnsProperty

Represents the CanUserResizeColumns dependency property.

Declaration

public static readonly DependencyProperty CanUserResizeColumnsProperty

Field Value

System.Windows.DependencyProperty

CanUserResizeRowsProperty

Represents the CanUserResizeRows dependency property.

Declaration

public static readonly DependencyProperty CanUserResizeRowsProperty

Field Value

System.Windows.DependencyProperty

CanUserSelectProperty

Represents the CanUserEdit dependency property.

Declaration

public static readonly DependencyProperty CanUserSelectProperty

Field Value

System.Windows.DependencyProperty

CanUserSortColumnsProperty

Represents the CanUserSortColumns dependency property.

Declaration

public static readonly DependencyProperty CanUserSortColumnsProperty

Field Value

System.Windows.DependencyProperty

CellPaddingProperty

Represents the CellPadding dependency property.

Declaration

public static readonly DependencyProperty CellPaddingProperty

Field Value

System.Windows.DependencyProperty

CellTextAlignmentProperty

Represents the CellTextAlignment dependency property.

Declaration

public static readonly DependencyProperty CellTextAlignmentProperty

Field Value

System.Windows.DependencyProperty

CellToolTipTemplateProperty

Identifies the CellToolTipTemplate dependency property.

Declaration

public static readonly DependencyProperty CellToolTipTemplateProperty

Field Value

System.Windows.DependencyProperty

ClipboardCopyModeProperty

Represents the ClipboardCopyMode dependency property.

Declaration

public static readonly DependencyProperty ClipboardCopyModeProperty

Field Value

System.Windows.DependencyProperty

ColumnAlternationCountProperty

Represents the ColumnAlternationCount dependency property.

Declaration

public static readonly DependencyProperty ColumnAlternationCountProperty

Field Value

System.Windows.DependencyProperty

ColumnHeaderBackgroundProperty

Represents the ColumnHeaderBackground dependency property.

Declaration

public static readonly DependencyProperty ColumnHeaderBackgroundProperty

Field Value

System.Windows.DependencyProperty

ColumnHeaderForegroundProperty

Represents the ColumnHeaderForeground dependency property.

Declaration

public static readonly DependencyProperty ColumnHeaderForegroundProperty

Field Value

System.Windows.DependencyProperty

ColumnHeaderHeightProperty

Represents the ColumnHeaderHeight dependency property.

Declaration

public static readonly DependencyProperty ColumnHeaderHeightProperty

Field Value

System.Windows.DependencyProperty

ColumnHeaderLinesBrushProperty

Represents the ColumnHeaderLinesBrush dependency property.

Declaration

public static readonly DependencyProperty ColumnHeaderLinesBrushProperty

Field Value

System.Windows.DependencyProperty

ColumnWidthProperty

Represents the ColumnWidth dependency property.

Declaration

public static readonly DependencyProperty ColumnWidthProperty

Field Value

System.Windows.DependencyProperty

CopiedEvent

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

Declaration

public static readonly RoutedEvent CopiedEvent

Field Value

System.Windows.RoutedEvent

CopyingCellClipboardContentEvent

Occurs on copying a cell to the Clipboard.

Declaration

public static readonly RoutedEvent CopyingCellClipboardContentEvent

Field Value

System.Windows.RoutedEvent

CopyingEvent

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

Declaration

public static readonly RoutedEvent CopyingEvent

Field Value

System.Windows.RoutedEvent

CurrentCellStrokeProperty

Represents the CurrentCellStroke dependency property.

Declaration

public static readonly DependencyProperty CurrentCellStrokeProperty

Field Value

System.Windows.DependencyProperty

DataProviderProperty

Represents the DataProvider dependency property.

Declaration

public static readonly DependencyProperty DataProviderProperty

Field Value

System.Windows.DependencyProperty

EditTriggersProperty

Represents the EditTriggers dependency property.

Declaration

public static readonly DependencyProperty EditTriggersProperty

Field Value

System.Windows.DependencyProperty

FilterIconBackgroundFilteredProperty

Represents the FilterIconBackgroundFiltered dependency property.

Declaration

public static readonly DependencyProperty FilterIconBackgroundFilteredProperty

Field Value

System.Windows.DependencyProperty

FilterIconBackgroundProperty

Represents the FilterIconBackground dependency property.

Declaration

public static readonly DependencyProperty FilterIconBackgroundProperty

Field Value

System.Windows.DependencyProperty

HorizontalLinesBrushProperty

Represents the HorizontalLinesBrush dependency property.

Declaration

public static readonly DependencyProperty HorizontalLinesBrushProperty

Field Value

System.Windows.DependencyProperty

InitialColumnCountProperty

Represents the InitialColumnCount dependency property.

Declaration

public static readonly DependencyProperty InitialColumnCountProperty

Field Value

System.Windows.DependencyProperty

InitialRowCountProperty

Represents the InitialRowCount dependency property.

Declaration

public static readonly DependencyProperty InitialRowCountProperty

Field Value

System.Windows.DependencyProperty

IsFilterableProperty

Represents the IsFilterable dependency property.

Declaration

public static readonly DependencyProperty IsFilterableProperty

Field Value

System.Windows.DependencyProperty

IsFilteringDeferredProperty

Represents the IsFilteringDeferred dependency property.

Declaration

public static readonly DependencyProperty IsFilteringDeferredProperty

Field Value

System.Windows.DependencyProperty

IsSortableProperty

Represents the IsSortable dependency property.

Declaration

public static readonly DependencyProperty IsSortableProperty

Field Value

System.Windows.DependencyProperty

LinesVisibilityProperty

Represents the LinesVisibility dependency property.

Declaration

public static readonly DependencyProperty LinesVisibilityProperty

Field Value

System.Windows.DependencyProperty

MeasureTextOnRenderProperty

Represents the MeasureTextOnRender dependency property.

Declaration

public static readonly DependencyProperty MeasureTextOnRenderProperty

Field Value

System.Windows.DependencyProperty

PinnedCellBackgroundProperty

Represents the PinnedCellBackground dependency property.

Declaration

public static readonly DependencyProperty PinnedCellBackgroundProperty

Field Value

System.Windows.DependencyProperty

PinnedCellForegroundProperty

Represents the PinnedCellForeground dependency property.

Declaration

public static readonly DependencyProperty PinnedCellForegroundProperty

Field Value

System.Windows.DependencyProperty

PinnedRowHeaderBackgroundProperty

Represents the PinnedRowHeaderBackground dependency property.

Declaration

public static readonly DependencyProperty PinnedRowHeaderBackgroundProperty

Field Value

System.Windows.DependencyProperty

RowAlternationCountProperty

Represents the RowAlternationCount dependency property.

Declaration

public static readonly DependencyProperty RowAlternationCountProperty

Field Value

System.Windows.DependencyProperty

RowHeaderBackgroundProperty

Represents the RowHeaderBackground dependency property.

Declaration

public static readonly DependencyProperty RowHeaderBackgroundProperty

Field Value

System.Windows.DependencyProperty

RowHeaderForegroundProperty

Represents the RowHeaderForeground dependency property.

Declaration

public static readonly DependencyProperty RowHeaderForegroundProperty

Field Value

System.Windows.DependencyProperty

RowHeaderLinesBrushProperty

Represents the RowHeaderLinesBrush dependency property.

Declaration

public static readonly DependencyProperty RowHeaderLinesBrushProperty

Field Value

System.Windows.DependencyProperty

RowHeaderWidthProperty

Represents the RowHeaderWidth dependency property.

Declaration

public static readonly DependencyProperty RowHeaderWidthProperty

Field Value

System.Windows.DependencyProperty

RowHeightProperty

Represents the RowHeight dependency property.

Declaration

public static readonly DependencyProperty RowHeightProperty

Field Value

System.Windows.DependencyProperty

SelectedIndexProperty

Identifies the SelectedIndexProperty dependency property.

Declaration

public static readonly DependencyProperty SelectedIndexProperty

Field Value

System.Windows.DependencyProperty

SelectionBrushProperty

Represents the SelectionBrush dependency property.

Declaration

public static readonly DependencyProperty SelectionBrushProperty

Field Value

System.Windows.DependencyProperty

SelectionChangedEvent

Identifies the SelectionChanged routed event.

Declaration

public static readonly RoutedEvent SelectionChangedEvent

Field Value

System.Windows.RoutedEvent

SelectionModeProperty

Identifies the SelectionModeProperty dependency property.

Declaration

public static readonly DependencyProperty SelectionModeProperty

Field Value

System.Windows.DependencyProperty

SelectionUnitProperty

Identifies the SelectionUnitProperty dependency property.

Declaration

public static readonly DependencyProperty SelectionUnitProperty

Field Value

System.Windows.DependencyProperty

ShouldCreateAutomationPeerProperty

Represents the ShouldCreateAutomationPeer dependency property.

Declaration

public static readonly DependencyProperty ShouldCreateAutomationPeerProperty

Field Value

System.Windows.DependencyProperty

ShowCellToolTipProperty

Represents the ShowCellToolTip dependency property.

Declaration

public static readonly DependencyProperty ShowCellToolTipProperty

Field Value

System.Windows.DependencyProperty

ShowDistinctFiltersProperty

Represents the ShowDistinctFilters dependency property.

Declaration

public static readonly DependencyProperty ShowDistinctFiltersProperty

Field Value

System.Windows.DependencyProperty

ShowFieldFiltersProperty

Represents the ShowFieldFilters dependency property.

Declaration

public static readonly DependencyProperty ShowFieldFiltersProperty

Field Value

System.Windows.DependencyProperty

SortedHeaderBackgroundProperty

Represents the SortedHeaderBackground dependency property.

Declaration

public static readonly DependencyProperty SortedHeaderBackgroundProperty

Field Value

System.Windows.DependencyProperty

SortedHeaderForegroundProperty

Represents the SortedHeaderForeground dependency property.

Declaration

public static readonly DependencyProperty SortedHeaderForegroundProperty

Field Value

System.Windows.DependencyProperty

SortIconBackgroundProperty

Represents the SortIndicatorBackground dependency property.

Declaration

public static readonly DependencyProperty SortIconBackgroundProperty

Field Value

System.Windows.DependencyProperty

VerticalLinesBrushProperty

Represents the VerticalLinesBrush dependency property.

Declaration

public static readonly DependencyProperty VerticalLinesBrushProperty

Field Value

System.Windows.DependencyProperty

Properties

ActionOnLostFocus

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

Declaration

public ActionOnLostFocus ActionOnLostFocus { get; set; }

Property Value

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

AlternationBrush

Get or sets the alternation color.

Declaration

public Brush AlternationBrush { get; set; }

Property Value

System.Windows.Media.Brush

CanUserDeleteRows

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

Declaration

public bool CanUserDeleteRows { get; set; }

Property Value

System.Boolean 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.

Declaration

public bool CanUserEdit { get; set; }

Property Value

System.Boolean The can user edit.

CanUserFilterColumns

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

Declaration

public bool CanUserFilterColumns { get; set; }

Property Value

System.Boolean

CanUserInsertRows

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

Declaration

public bool CanUserInsertRows { get; set; }

Property Value

System.Boolean 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.

Declaration

public bool CanUserResizeColumns { get; set; }

Property Value

System.Boolean

CanUserResizeRows

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

Declaration

public bool CanUserResizeRows { get; set; }

Property Value

System.Boolean

CanUserSelect

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

Declaration

public bool CanUserSelect { get; set; }

Property Value

System.Boolean The can user edit.

CanUserSortColumns

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

Declaration

public bool CanUserSortColumns { get; set; }

Property Value

System.Boolean

CellPadding

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

Declaration

public Thickness CellPadding { get; set; }

Property Value

System.Windows.Thickness

CellTextAlignment

Gets or sets the text alignment.

Declaration

public TextAlignment CellTextAlignment { get; set; }

Property Value

System.Windows.TextAlignment

CellToolTipTemplate

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

Declaration

public DataTemplate CellToolTipTemplate { get; set; }

Property Value

System.Windows.DataTemplate

ClipboardCopyMode

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

Declaration

public VirtualGridClipboardCopyMode ClipboardCopyMode { get; set; }

Property Value

VirtualGridClipboardCopyMode

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.

Declaration

public int ColumnAlternationCount { get; set; }

Property Value

System.Int32

ColumnHeaderBackground

Gets or sets the column headers' background.

Declaration

public Brush ColumnHeaderBackground { get; set; }

Property Value

System.Windows.Media.Brush

ColumnHeaderForeground

Gets or sets the column headers' foreground.

Declaration

public Brush ColumnHeaderForeground { get; set; }

Property Value

System.Windows.Media.Brush

ColumnHeaderHeight

Gets or sets the height of the column headers.

Declaration

public double ColumnHeaderHeight { get; set; }

Property Value

System.Double

ColumnHeaderLinesBrush

Gets or sets the column header lines' stroke brush.

Declaration

public Brush ColumnHeaderLinesBrush { get; set; }

Property Value

System.Windows.Media.Brush

ColumnWidth

Gets or sets the width of the columns.

Declaration

public double ColumnWidth { get; set; }

Property Value

System.Double

CurrentCellInfo

Gets or sets the current cell info.

Declaration

public VirtualGridCellInfo CurrentCellInfo { get; set; }

Property Value

VirtualGridCellInfo The current cell info.

CurrentCellStroke

Gets or sets the stroke brush of the current cell.

Declaration

public Brush CurrentCellStroke { get; set; }

Property Value

System.Windows.Media.Brush

DataProvider

Gets or sets the data provider.

Declaration

public DataProvider DataProvider { get; set; }

Property Value

DataProvider

EditTriggers

Gets or sets the edit triggers.

Declaration

public VirtualGridEditTriggers EditTriggers { get; set; }

Property Value

VirtualGridEditTriggers The edit triggers.

FilterIconBackground

Gets or sets the filter icon background brush.

Declaration

public Brush FilterIconBackground { get; set; }

Property Value

System.Windows.Media.Brush

FilterIconBackgroundFiltered

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

Declaration

public Brush FilterIconBackgroundFiltered { get; set; }

Property Value

System.Windows.Media.Brush

HorizontalLinesBrush

Gets or sets the horizontal lines' stroke brush.

Declaration

public Brush HorizontalLinesBrush { get; set; }

Property Value

System.Windows.Media.Brush

InitialColumnCount

Gets or sets the initial column count.

Declaration

public int InitialColumnCount { get; set; }

Property Value

System.Int32

InitialRowCount

Gets or sets the initial row count.

Declaration

public int InitialRowCount { get; set; }

Property Value

System.Int32

IsFilterable

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

Declaration

public bool IsFilterable { get; set; }

Property Value

System.Boolean

IsFilteringDeferred

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

Declaration

public bool IsFilteringDeferred { get; set; }

Property Value

System.Boolean

IsSortable

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

Declaration

public bool IsSortable { get; set; }

Property Value

System.Boolean

KeyboardCommandProvider

Gets the keyboard command provider.

Declaration

public IKeyboardCommandProvider KeyboardCommandProvider { get; set; }

Property Value

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

LinesVisibility

Gets or sets the lines' visibility.

Declaration

public VirtualGridLinesVisibility LinesVisibility { get; set; }

Property Value

VirtualGridLinesVisibility

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.

Declaration

public bool MeasureTextOnRender { get; set; }

Property Value

System.Boolean

PendingCommands

Gets all pending commands.

Declaration

public List<ICommand> PendingCommands { get; }

Property Value

System.Collections.Generic.List<System.Windows.Input.ICommand> The pending commands.

PinnedCellBackground

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

Declaration

public Brush PinnedCellBackground { get; set; }

Property Value

System.Windows.Media.Brush

PinnedCellForeground

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

Declaration

public Brush PinnedCellForeground { get; set; }

Property Value

System.Windows.Media.Brush

PinnedRowHeaderBackground

Gets or sets the pinned row headers' background.

Declaration

public Brush PinnedRowHeaderBackground { get; set; }

Property Value

System.Windows.Media.Brush

RowAlternationCount

Gets or sets the alternation step for rows.

Declaration

public int RowAlternationCount { get; set; }

Property Value

System.Int32

RowHeaderBackground

Gets or sets the row headers' background.

Declaration

public Brush RowHeaderBackground { get; set; }

Property Value

System.Windows.Media.Brush

RowHeaderForeground

Gets or sets the row header's foreground.

Declaration

public Brush RowHeaderForeground { get; set; }

Property Value

System.Windows.Media.Brush

RowHeaderLinesBrush

Gets or sets the row header lines' stroke brush.

Declaration

public Brush RowHeaderLinesBrush { get; set; }

Property Value

System.Windows.Media.Brush

RowHeaderWidth

Gets or sets the width of the row headers.

Declaration

public double RowHeaderWidth { get; set; }

Property Value

System.Double

RowHeight

Gets or sets the height of the rows.

Declaration

public double RowHeight { get; set; }

Property Value

System.Double

SelectedCells

Gets the selected cells.

Declaration

public IList<VirtualGridCellInfo> SelectedCells { get; }

Property Value

System.Collections.Generic.IList<VirtualGridCellInfo>

SelectedIndex

Gets or sets the selected index of RadVirtualGrid.

Declaration

public int SelectedIndex { get; set; }

Property Value

System.Int32

SelectedIndexes

Gets the selected indexes.

Declaration

public IEnumerable<int> SelectedIndexes { get; }

Property Value

System.Collections.Generic.IEnumerable<System.Int32>

SelectionBrush

Gets or sets a value that indicates the selection brush.

Declaration

public Brush SelectionBrush { get; set; }

Property Value

System.Windows.Media.Brush

SelectionMode

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

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

System.Windows.Controls.SelectionMode

SelectionUnit

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

Declaration

public VirtualGridSelectionUnit SelectionUnit { get; set; }

Property Value

VirtualGridSelectionUnit

ShouldCreateAutomationPeer

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

Declaration

public bool ShouldCreateAutomationPeer { get; set; }

Property Value

System.Boolean

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.

Declaration

public bool ShowCellToolTip { get; set; }

Property Value

System.Boolean

ShowDistinctFilters

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

Declaration

public bool ShowDistinctFilters { get; set; }

Property Value

System.Boolean

ShowFieldFilters

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

Declaration

public bool ShowFieldFilters { get; set; }

Property Value

System.Boolean

SortedHeaderBackground

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

Declaration

public Brush SortedHeaderBackground { get; set; }

Property Value

System.Windows.Media.Brush

SortedHeaderForeground

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

Declaration

public Brush SortedHeaderForeground { get; set; }

Property Value

System.Windows.Media.Brush

SortIconBackground

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

Declaration

public Brush SortIconBackground { get; set; }

Property Value

System.Windows.Media.Brush

VerticalLinesBrush

Gets or sets the vertical lines' stroke brush.

Declaration

public Brush VerticalLinesBrush { get; set; }

Property Value

System.Windows.Media.Brush

Methods

ApplyFilterDescriptorChanges(ColumnFilterDescriptor)

Propagates filter descriptor changes.

Declaration

protected virtual void ApplyFilterDescriptorChanges(ColumnFilterDescriptor filterDescriptor)

Parameters

ColumnFilterDescriptor filterDescriptor

BeginEdit(Int32, Int32)

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

Declaration

public void BeginEdit(int rowIndex, int columnIndex)

Parameters

System.Int32 rowIndex

System.Int32 columnIndex

BeginInsert()

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

Declaration

public void BeginInsert()

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

Generates FilteredEventArgs and invokes the FilterDescriptorPrepared event.

Declaration

protected virtual void CallFiltered(IEnumerable<IFilterDescriptor> added, IEnumerable<IFilterDescriptor> removed, int columnIndex)

Parameters

System.Collections.Generic.IEnumerable<IFilterDescriptor> added

System.Collections.Generic.IEnumerable<IFilterDescriptor> removed

System.Int32 columnIndex

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

Generates FilteringEventArgs and invokes the FilterDescriptorPreparing event.

Declaration

protected virtual bool CallFiltering(IEnumerable<IFilterDescriptor> added, IEnumerable<IFilterDescriptor> removed, int columnIndex)

Parameters

System.Collections.Generic.IEnumerable<IFilterDescriptor> added

System.Collections.Generic.IEnumerable<IFilterDescriptor> removed

System.Int32 columnIndex

Returns

System.Boolean

CancelEdit()

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

Declaration

public void CancelEdit()

ClearColumnFilters()

Clears all existing column filters.

Declaration

public virtual void ClearColumnFilters()

ClearFiltersForColumn(Int32)

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

Declaration

public virtual void ClearFiltersForColumn(int columnIndex)

Parameters

System.Int32 columnIndex

CloseFilteringControl()

Closes the filtering UI.

Declaration

public void CloseFilteringControl()

CommitEdit()

Commits the edit.

Declaration

public void CommitEdit()

CopyToClipboard()

Copies RadVirtualGrid selected cells to clipboard.

Declaration

public void CopyToClipboard()

ExecutePendingCommand()

Executes all pending commands in a sequence.

Declaration

public void ExecutePendingCommand()

FilterColumn(Int32)

Invokes the filtering UI for a specific column.

Declaration

public void FilterColumn(int columnIndex)

Parameters

System.Int32 columnIndex

FitColumnWidthToContent(Int32)

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

Declaration

public double FitColumnWidthToContent(int columnIndex)

Parameters

System.Int32 columnIndex

Returns

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

GetAvailableOperatorsForType(Type)

Retrieves the list of available FilterOperators for a given type.

Declaration

protected virtual List<FilterOperator> GetAvailableOperatorsForType(Type dataType)

Parameters

System.Type dataType

Returns

System.Collections.Generic.List<FilterOperator>

GetColumnIndexAtMousePosition(CanvasInputBorder)

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

Declaration

public int GetColumnIndexAtMousePosition(CanvasInputBorder canvasInputBorder)

Parameters

CanvasInputBorder canvasInputBorder

Returns

System.Int32

GetFilterDescriptorForColumn(Int32)

Gets the ColumnFilterDescriptor for a specific column.

Declaration

public ColumnFilterDescriptor GetFilterDescriptorForColumn(int columnIndex)

Parameters

System.Int32 columnIndex

Returns

ColumnFilterDescriptor

GetFilteringControlForColumn(Int32)

Gets the FilteringControl for a specific column.

Declaration

public FilteringControl GetFilteringControlForColumn(int columnIndex)

Parameters

System.Int32 columnIndex

Returns

FilteringControl

GetRowIndexAtMousePosition(CanvasInputBorder)

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

Declaration

public int GetRowIndexAtMousePosition(CanvasInputBorder canvasInputBorder)

Parameters

CanvasInputBorder canvasInputBorder

Returns

System.Int32

GetSortDescriptorForColumn(Int32)

Gets the ColumnSortDescriptor for a specific column.

Declaration

public ColumnSortDescriptor GetSortDescriptorForColumn(int columnIndex)

Parameters

System.Int32 columnIndex

Returns

ColumnSortDescriptor

InsertNewColumnAtIndex(Int32)

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

Declaration

public void InsertNewColumnAtIndex(int index)

Parameters

System.Int32 index

InsertNewRowAtIndex(Int32)

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

Declaration

public void InsertNewRowAtIndex(int index)

Parameters

System.Int32 index

OnApplyTemplate()

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

Declaration

public override void OnApplyTemplate()

OnCreateAutomationPeer()

Returns an automation peer for RadVirtualGrid.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer

OnDistinctValuesLoading(DistinctValuesLoadingEventArgs)

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

Declaration

protected virtual void OnDistinctValuesLoading(DistinctValuesLoadingEventArgs e)

Parameters

DistinctValuesLoadingEventArgs e

OnFieldFilterEditorCreated(FieldFilterEditorCreatedEventArgs)

Declaration

protected virtual void OnFieldFilterEditorCreated(FieldFilterEditorCreatedEventArgs args)

Parameters

FieldFilterEditorCreatedEventArgs args

OnFiltered(FilteredEventArgs)

Invokes the FilterDescriptorPrepared event.

Declaration

protected virtual void OnFiltered(FilteredEventArgs e)

Parameters

FilteredEventArgs e

OnFiltering(FilteringEventArgs)

Invokes the FilterDescriptorsPreparing event.

Declaration

protected virtual void OnFiltering(FilteringEventArgs e)

Parameters

FilteringEventArgs e

OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs)

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

Declaration

protected void OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)

Parameters

FilterOperatorsLoadingEventArgs e

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

System.EventArgs e The System.Windows.RoutedEventArgs that contains the event data.

OnPreviewKeyDown(KeyEventArgs)

Occurs when KeyDown event is raised.

Declaration

protected override void OnPreviewKeyDown(KeyEventArgs e)

Parameters

System.Windows.Input.KeyEventArgs e

OnSelectedCellsChanging(VirtualGridSelectedCellsChangingEventArgs)

Raises the SelectedCellsChangingEvent event.

Declaration

protected virtual void OnSelectedCellsChanging(VirtualGridSelectedCellsChangingEventArgs args)

Parameters

VirtualGridSelectedCellsChangingEventArgs args The VirtualGridSelectedCellsChangingEventArgs instance containing the event data.

OnSorted(SortedEventArgs)

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

Declaration

protected virtual void OnSorted(SortedEventArgs e)

Parameters

SortedEventArgs e

OnSorting(SortingEventArgs)

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

Declaration

protected virtual void OnSorting(SortingEventArgs e)

Parameters

SortingEventArgs e

OnTextInput(TextCompositionEventArgs)

Executed when text has been input.

Declaration

protected override void OnTextInput(TextCompositionEventArgs e)

Parameters

System.Windows.Input.TextCompositionEventArgs e Event args.

PinColumnLeft(Int32)

Pins the column left.

Declaration

public void PinColumnLeft(int columnIndex)

Parameters

System.Int32 columnIndex

PinColumnRight(Int32)

Pins the column right.

Declaration

public void PinColumnRight(int columnIndex)

Parameters

System.Int32 columnIndex

PinRowBottom(Int32)

Pins the row bottom.

Declaration

public void PinRowBottom(int rowIndex)

Parameters

System.Int32 rowIndex

PinRowTop(Int32)

Pins the row top.

Declaration

public void PinRowTop(int rowIndex)

Parameters

System.Int32 rowIndex

PushCellValue(Int32, Int32, Object)

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

Declaration

public void PushCellValue(int rowIndex, int columnIndex, object value)

Parameters

System.Int32 rowIndex

System.Int32 columnIndex

System.Object value

RemoveColumnAtIndex(Int32)

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

Declaration

public void RemoveColumnAtIndex(int index)

Parameters

System.Int32 index

RemoveRowAtIndex(Int32)

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

Declaration

public void RemoveRowAtIndex(int index)

Parameters

System.Int32 index

Reset()

Resets the control to its initial visual state.

Declaration

public void Reset()

Reset(Int32, Int32)

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

Declaration

public void Reset(int rowCount, int columnCount)

Parameters

System.Int32 rowCount

System.Int32 columnCount

ResetTheme()

Resets the theme.

Declaration

public void ResetTheme()

ScrollColumnIndexIntoViewAsync(Int32, Action, Action)

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

Declaration

public void ScrollColumnIndexIntoViewAsync(int columnIndex, Action scrollFinishedCallback, Action scrollFailedCallback)

Parameters

System.Int32 columnIndex The column index to scroll into view.

System.Action scrollFinishedCallback The method to execute when scrolling has finished.

System.Action scrollFailedCallback 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(Int32, Int32, Action, Action)

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

Declaration

public void ScrollIndexIntoViewAsync(int rowIndex, int columnIndex, Action scrollFinishedCallback, Action scrollFailedCallback)

Parameters

System.Int32 rowIndex The row index to scroll into view.

System.Int32 columnIndex The column index to scroll into view.

System.Action scrollFinishedCallback The method to execute when scrolling has finished.

System.Action scrollFailedCallback 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(Int32, Action, Action)

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

Declaration

public void ScrollRowIndexIntoViewAsync(int rowIndex, Action scrollFinishedCallback, Action scrollFailedCallback)

Parameters

System.Int32 rowIndex The row index to scroll into view.

System.Action scrollFinishedCallback The method to execute when scrolling has finished.

System.Action scrollFailedCallback 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

Declaration

public void SelectAll()

SelectCellRegion(IEnumerable<CellRegion>)

Selects specified region of cells.

Declaration

public void SelectCellRegion(IEnumerable<CellRegion> cellRegions)

Parameters

System.Collections.Generic.IEnumerable<CellRegion> cellRegions

SelectCellRegion(CellRegion)

Selects specified region of cells.

Declaration

public void SelectCellRegion(CellRegion cellRegion)

Parameters

CellRegion cellRegion

SortColumn(Int32)

Invokes the sorting UI for a specific column.

Declaration

public void SortColumn(int columnIndex)

Parameters

System.Int32 columnIndex

ToggleIndexSelection(Int32)

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

Declaration

public void ToggleIndexSelection(int index)

Parameters

System.Int32 index

UnpinColumn(Int32)

Unpins the column with the given index.

Declaration

public void UnpinColumn(int columnIndex)

Parameters

System.Int32 columnIndex

UnpinRow(Int32)

Unpins the row with the given index.

Declaration

public void UnpinRow(int rowIndex)

Parameters

System.Int32 rowIndex

UnselectAll()

Clears the current selection state.

Declaration

public void UnselectAll()

UnselectCellRegion(IEnumerable<CellRegion>)

Deselects specified region of cells.

Declaration

public void UnselectCellRegion(IEnumerable<CellRegion> cellRegions)

Parameters

System.Collections.Generic.IEnumerable<CellRegion> cellRegions

UnselectCellRegion(CellRegion)

Deselects specified region of cells.

Declaration

public void UnselectCellRegion(CellRegion cellRegion)

Parameters

CellRegion cellRegion

UpdateHeadersUI()

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

Declaration

public void UpdateHeadersUI()

UpdateUI()

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

Declaration

public void UpdateUI()

Events

CellDecorationsNeeded

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

Declaration

public event EventHandler<CellDecorationEventArgs> CellDecorationsNeeded

Event Type

System.EventHandler<CellDecorationEventArgs>

CellEditEnded

Occurs when an edit operation is finished.

Declaration

public event EventHandler<CellEditEndedEventArgs> CellEditEnded

Event Type

System.EventHandler<CellEditEndedEventArgs>

CellTemplateNeeded

Occurs when RadVirtualGrid fetches the DataTemplate for a given cell.

Declaration

public event EventHandler<CellTemplateEventArgs> CellTemplateNeeded

Event Type

System.EventHandler<CellTemplateEventArgs>

CellToolTipNeeded

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

Declaration

public event EventHandler<VirtualGridCellToolTipEventArgs> CellToolTipNeeded

Event Type

System.EventHandler<VirtualGridCellToolTipEventArgs>

CellValueNeeded

Occurs when RadVirtualGrid fetches the value for a cell.

Declaration

public event EventHandler<CellValueEventArgs> CellValueNeeded

Event Type

System.EventHandler<CellValueEventArgs>

Copied

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

Declaration

public event EventHandler<RadRoutedEventArgs> Copied

Event Type

System.EventHandler<RadRoutedEventArgs>

Copying

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

Declaration

public event EventHandler<VirtualGridClipboardEventArgs> Copying

Event Type

System.EventHandler<VirtualGridClipboardEventArgs>

CopyingCellClipboardContent

Occurs before a cell is copied to the Clipboard.

Declaration

public event EventHandler<VirtualGridCellClipboardEventArgs> CopyingCellClipboardContent

Event Type

System.EventHandler<VirtualGridCellClipboardEventArgs>

CurrentCellChanged

Occurs when the current cell is changed.

Declaration

public event EventHandler<VirtualGridCurrentCellChangedEventArgs> CurrentCellChanged

Event Type

System.EventHandler<VirtualGridCurrentCellChangedEventArgs>

DataMemberNeeded

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

Declaration

public event EventHandler<DataMemberEventArgs> DataMemberNeeded

Event Type

System.EventHandler<DataMemberEventArgs>

Deleted

Occurs when VirtualGrid's selected indexes are deleted.

Declaration

public event EventHandler<VirtualGridDeletedEventArgs> Deleted

Event Type

System.EventHandler<VirtualGridDeletedEventArgs>

Deleting

Occurs when deleting the VirtualGrid's selected indexes.

Declaration

public event EventHandler<VirtualGridDeletingEventArgs> Deleting

Event Type

System.EventHandler<VirtualGridDeletingEventArgs>

DistinctValuesLoading

Occurs when distinct values are being loaded.

Declaration

public event EventHandler<DistinctValuesLoadingEventArgs> DistinctValuesLoading

Event Type

System.EventHandler<DistinctValuesLoadingEventArgs>

EditorNeeded

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

Declaration

public event EventHandler<EditorNeededEventArgs> EditorNeeded

Event Type

System.EventHandler<EditorNeededEventArgs>

EditorValueChanged

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

Declaration

public event EventHandler<CellValueEventArgs> EditorValueChanged

Event Type

System.EventHandler<CellValueEventArgs>

FieldFilterEditorCreated

Occurs when filed filter editor is created.

Declaration

public event EventHandler<FieldFilterEditorCreatedEventArgs> FieldFilterEditorCreated

Event Type

System.EventHandler<FieldFilterEditorCreatedEventArgs>

FilterDescriptorsPrepared

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

Declaration

public event EventHandler<FilteredEventArgs> FilterDescriptorsPrepared

Event Type

System.EventHandler<FilteredEventArgs>

FilterDescriptorsPreparing

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

Declaration

public event EventHandler<FilteringEventArgs> FilterDescriptorsPreparing

Event Type

System.EventHandler<FilteringEventArgs>

FilterOperatorsLoading

Occurs when filter operators are being loaded.

Declaration

public event EventHandler<FilterOperatorsLoadingEventArgs> FilterOperatorsLoading

Event Type

System.EventHandler<FilterOperatorsLoadingEventArgs>

HeaderCellDecorationsNeeded

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

Declaration

public event EventHandler<HeaderCellDecorationEventArgs> HeaderCellDecorationsNeeded

Event Type

System.EventHandler<HeaderCellDecorationEventArgs>

HeaderSizeNeeded

Occurs when size for a header cell is needed.

Declaration

public event EventHandler<HeaderSizeEventArgs> HeaderSizeNeeded

Event Type

System.EventHandler<HeaderSizeEventArgs>

HeaderValueNeeded

Occurs when header cell values is needed.

Declaration

public event EventHandler<HeaderValueEventArgs> HeaderValueNeeded

Event Type

System.EventHandler<HeaderValueEventArgs>

OverlayBrushesNeeded

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

Declaration

public event EventHandler<OverlayBrushesEventArgs> OverlayBrushesNeeded

Event Type

System.EventHandler<OverlayBrushesEventArgs>

SelectedCellsChanged

Event that fires when the SelectedCells collection is changed.

Declaration

public event EventHandler<VirtualGridSelectedCellsChangedEventArgs> SelectedCellsChanged

Event Type

System.EventHandler<VirtualGridSelectedCellsChangedEventArgs>

SelectedCellsChanging

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

Declaration

public event EventHandler<VirtualGridSelectedCellsChangingEventArgs> SelectedCellsChanging

Event Type

System.EventHandler<VirtualGridSelectedCellsChangingEventArgs>

SelectionChanged

Event that fires when the selection of RadVirtualGrid is changed.

Declaration

public event SelectionChangedEventHandler SelectionChanged

Event Type

System.Windows.Controls.SelectionChangedEventHandler

SortDescriptorPrepared

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

Declaration

public event EventHandler<SortedEventArgs> SortDescriptorPrepared

Event Type

System.EventHandler<SortedEventArgs>

SortDescriptorPreparing

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

Declaration

public event EventHandler<SortingEventArgs> SortDescriptorPreparing

Event Type

System.EventHandler<SortingEventArgs>

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)