ClassRadVirtualGrid
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:
[TelerikToolboxCategory("Data")]
public class RadVirtualGrid : Control
Inheritance: objectRadVirtualGrid
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
DependencyProperty
AlternationBrushProperty
Represents the AlternationBrush dependency property.
Declaration
public static readonly DependencyProperty AlternationBrushProperty
Field Value
DependencyProperty
CanUserDeleteRowsProperty
Represents the CanUserDeleteRows dependency property.
Declaration
public static readonly DependencyProperty CanUserDeleteRowsProperty
Field Value
DependencyProperty
CanUserEditProperty
Represents the CanUserEdit dependency property.
Declaration
public static readonly DependencyProperty CanUserEditProperty
Field Value
DependencyProperty
CanUserFilterColumnsProperty
Represents the CanUserFilterColumns dependency property.
Declaration
public static readonly DependencyProperty CanUserFilterColumnsProperty
Field Value
DependencyProperty
CanUserInsertRowsProperty
Represents the CanUserInsertRows dependency property.
Declaration
public static readonly DependencyProperty CanUserInsertRowsProperty
Field Value
DependencyProperty
CanUserResizeColumnsProperty
Represents the CanUserResizeColumns dependency property.
Declaration
public static readonly DependencyProperty CanUserResizeColumnsProperty
Field Value
DependencyProperty
CanUserResizeRowsProperty
Represents the CanUserResizeRows dependency property.
Declaration
public static readonly DependencyProperty CanUserResizeRowsProperty
Field Value
DependencyProperty
CanUserSelectProperty
Represents the CanUserEdit dependency property.
Declaration
public static readonly DependencyProperty CanUserSelectProperty
Field Value
DependencyProperty
CanUserSortColumnsProperty
Represents the CanUserSortColumns dependency property.
Declaration
public static readonly DependencyProperty CanUserSortColumnsProperty
Field Value
DependencyProperty
CellPaddingProperty
Represents the CellPadding dependency property.
Declaration
public static readonly DependencyProperty CellPaddingProperty
Field Value
DependencyProperty
CellTextAlignmentProperty
Represents the CellTextAlignment dependency property.
Declaration
public static readonly DependencyProperty CellTextAlignmentProperty
Field Value
DependencyProperty
CellToolTipTemplateProperty
Identifies the CellToolTipTemplate dependency property.
Declaration
public static readonly DependencyProperty CellToolTipTemplateProperty
Field Value
DependencyProperty
ClipboardCopyModeProperty
Represents the ClipboardCopyMode dependency property.
Declaration
public static readonly DependencyProperty ClipboardCopyModeProperty
Field Value
DependencyProperty
ColumnAlternationCountProperty
Represents the ColumnAlternationCount dependency property.
Declaration
public static readonly DependencyProperty ColumnAlternationCountProperty
Field Value
DependencyProperty
ColumnHeaderBackgroundProperty
Represents the ColumnHeaderBackground dependency property.
Declaration
public static readonly DependencyProperty ColumnHeaderBackgroundProperty
Field Value
DependencyProperty
ColumnHeaderForegroundProperty
Represents the ColumnHeaderForeground dependency property.
Declaration
public static readonly DependencyProperty ColumnHeaderForegroundProperty
Field Value
DependencyProperty
ColumnHeaderHeightProperty
Represents the ColumnHeaderHeight dependency property.
Declaration
public static readonly DependencyProperty ColumnHeaderHeightProperty
Field Value
DependencyProperty
ColumnHeaderLinesBrushProperty
Represents the ColumnHeaderLinesBrush dependency property.
Declaration
public static readonly DependencyProperty ColumnHeaderLinesBrushProperty
Field Value
DependencyProperty
ColumnWidthProperty
Represents the ColumnWidth dependency property.
Declaration
public static readonly DependencyProperty ColumnWidthProperty
Field Value
DependencyProperty
CopiedEvent
Occurs after copying the RadVirtualGrid's selected cells to the Clipboard.
Declaration
public static readonly RoutedEvent CopiedEvent
Field Value
RoutedEvent
CopyingCellClipboardContentEvent
Occurs on copying a cell to the Clipboard.
Declaration
public static readonly RoutedEvent CopyingCellClipboardContentEvent
Field Value
RoutedEvent
CopyingEvent
Occurs on copying the RadVirtualGrid's selected cells to the Clipboard.
Declaration
public static readonly RoutedEvent CopyingEvent
Field Value
RoutedEvent
CurrentCellStrokeProperty
Represents the CurrentCellStroke dependency property.
Declaration
public static readonly DependencyProperty CurrentCellStrokeProperty
Field Value
DependencyProperty
DataProviderProperty
Represents the DataProvider dependency property.
Declaration
public static readonly DependencyProperty DataProviderProperty
Field Value
DependencyProperty
EditTriggersProperty
Represents the EditTriggers dependency property.
Declaration
public static readonly DependencyProperty EditTriggersProperty
Field Value
DependencyProperty
FilterIconBackgroundFilteredProperty
Represents the FilterIconBackgroundFiltered dependency property.
Declaration
public static readonly DependencyProperty FilterIconBackgroundFilteredProperty
Field Value
DependencyProperty
FilterIconBackgroundProperty
Represents the FilterIconBackground dependency property.
Declaration
public static readonly DependencyProperty FilterIconBackgroundProperty
Field Value
DependencyProperty
HorizontalLinesBrushProperty
Represents the HorizontalLinesBrush dependency property.
Declaration
public static readonly DependencyProperty HorizontalLinesBrushProperty
Field Value
DependencyProperty
InitialColumnCountProperty
Represents the InitialColumnCount dependency property.
Declaration
public static readonly DependencyProperty InitialColumnCountProperty
Field Value
DependencyProperty
InitialRowCountProperty
Represents the InitialRowCount dependency property.
Declaration
public static readonly DependencyProperty InitialRowCountProperty
Field Value
DependencyProperty
IsFilterableProperty
Represents the IsFilterable dependency property.
Declaration
public static readonly DependencyProperty IsFilterableProperty
Field Value
DependencyProperty
IsFilteringDeferredProperty
Represents the IsFilteringDeferred dependency property.
Declaration
public static readonly DependencyProperty IsFilteringDeferredProperty
Field Value
DependencyProperty
IsSortableProperty
Represents the IsSortable dependency property.
Declaration
public static readonly DependencyProperty IsSortableProperty
Field Value
DependencyProperty
LinesVisibilityProperty
Represents the LinesVisibility dependency property.
Declaration
public static readonly DependencyProperty LinesVisibilityProperty
Field Value
DependencyProperty
MeasureTextOnRenderProperty
Represents the MeasureTextOnRender dependency property.
Declaration
public static readonly DependencyProperty MeasureTextOnRenderProperty
Field Value
DependencyProperty
PinnedCellBackgroundProperty
Represents the PinnedCellBackground dependency property.
Declaration
public static readonly DependencyProperty PinnedCellBackgroundProperty
Field Value
DependencyProperty
PinnedCellForegroundProperty
Represents the PinnedCellForeground dependency property.
Declaration
public static readonly DependencyProperty PinnedCellForegroundProperty
Field Value
DependencyProperty
PinnedRowHeaderBackgroundProperty
Represents the PinnedRowHeaderBackground dependency property.
Declaration
public static readonly DependencyProperty PinnedRowHeaderBackgroundProperty
Field Value
DependencyProperty
RowAlternationCountProperty
Represents the RowAlternationCount dependency property.
Declaration
public static readonly DependencyProperty RowAlternationCountProperty
Field Value
DependencyProperty
RowHeaderBackgroundProperty
Represents the RowHeaderBackground dependency property.
Declaration
public static readonly DependencyProperty RowHeaderBackgroundProperty
Field Value
DependencyProperty
RowHeaderForegroundProperty
Represents the RowHeaderForeground dependency property.
Declaration
public static readonly DependencyProperty RowHeaderForegroundProperty
Field Value
DependencyProperty
RowHeaderLinesBrushProperty
Represents the RowHeaderLinesBrush dependency property.
Declaration
public static readonly DependencyProperty RowHeaderLinesBrushProperty
Field Value
DependencyProperty
RowHeaderWidthProperty
Represents the RowHeaderWidth dependency property.
Declaration
public static readonly DependencyProperty RowHeaderWidthProperty
Field Value
DependencyProperty
RowHeightProperty
Represents the RowHeight dependency property.
Declaration
public static readonly DependencyProperty RowHeightProperty
Field Value
DependencyProperty
SelectedIndexProperty
Identifies the SelectedIndexProperty dependency property.
Declaration
public static readonly DependencyProperty SelectedIndexProperty
Field Value
DependencyProperty
SelectionBrushProperty
Represents the SelectionBrush dependency property.
Declaration
public static readonly DependencyProperty SelectionBrushProperty
Field Value
DependencyProperty
SelectionChangedEvent
Identifies the SelectionChanged routed event.
Declaration
public static readonly RoutedEvent SelectionChangedEvent
Field Value
RoutedEvent
SelectionModeProperty
Identifies the SelectionModeProperty dependency property.
Declaration
public static readonly DependencyProperty SelectionModeProperty
Field Value
DependencyProperty
SelectionUnitProperty
Identifies the SelectionUnitProperty dependency property.
Declaration
public static readonly DependencyProperty SelectionUnitProperty
Field Value
DependencyProperty
ShouldCreateAutomationPeerProperty
Represents the ShouldCreateAutomationPeer dependency property.
Declaration
public static readonly DependencyProperty ShouldCreateAutomationPeerProperty
Field Value
DependencyProperty
ShowCellToolTipProperty
Represents the ShowCellToolTip dependency property.
Declaration
public static readonly DependencyProperty ShowCellToolTipProperty
Field Value
DependencyProperty
ShowDistinctFiltersProperty
Represents the ShowDistinctFilters dependency property.
Declaration
public static readonly DependencyProperty ShowDistinctFiltersProperty
Field Value
DependencyProperty
ShowFieldFiltersProperty
Represents the ShowFieldFilters dependency property.
Declaration
public static readonly DependencyProperty ShowFieldFiltersProperty
Field Value
DependencyProperty
SortIconBackgroundProperty
Represents the SortIndicatorBackground dependency property.
Declaration
public static readonly DependencyProperty SortIconBackgroundProperty
Field Value
DependencyProperty
SortedHeaderBackgroundProperty
Represents the SortedHeaderBackground dependency property.
Declaration
public static readonly DependencyProperty SortedHeaderBackgroundProperty
Field Value
DependencyProperty
SortedHeaderForegroundProperty
Represents the SortedHeaderForeground dependency property.
Declaration
public static readonly DependencyProperty SortedHeaderForegroundProperty
Field Value
DependencyProperty
VerticalLinesBrushProperty
Represents the VerticalLinesBrush dependency property.
Declaration
public static readonly DependencyProperty VerticalLinesBrushProperty
Field Value
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
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
Brush
CanUserDeleteRows
Gets or sets a value that indicates whether the user can delete rows.
Declaration
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.
Declaration
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.
CanUserInsertRows
Gets or sets a value that indicates whether the user can add new rows.
Declaration
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.
CanUserResizeRows
Gets or sets a value that indicates whether users can resize rows through the UI.
CanUserSelect
Gets or sets a value that indicates whether a user can select rows or cells.
Declaration
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.
CellPadding
Gets or sets a value that indicates the cells' text padding.
Declaration
public Thickness CellPadding { get; set; }
Property Value
Thickness
CellTextAlignment
Gets or sets the text alignment.
Declaration
public TextAlignment CellTextAlignment { get; set; }
Property Value
TextAlignment
CellToolTipTemplate
Gets or sets the ContentTemplate of the tooltip that is shown for RadVirtualGrid cells.
Declaration
public DataTemplate CellToolTipTemplate { get; set; }
Property Value
DataTemplate
ClipboardCopyMode
Gets or sets a value that indicates how data is copied to the clipboard.
Declaration
public VirtualGridClipboardCopyMode ClipboardCopyMode { get; set; }
Property Value
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.
ColumnHeaderBackground
Gets or sets the column headers' background.
Declaration
public Brush ColumnHeaderBackground { get; set; }
Property Value
Brush
ColumnHeaderForeground
Gets or sets the column headers' foreground.
Declaration
public Brush ColumnHeaderForeground { get; set; }
Property Value
Brush
ColumnHeaderHeight
Gets or sets the height of the column headers.
ColumnHeaderLinesBrush
Gets or sets the column header lines' stroke brush.
Declaration
public Brush ColumnHeaderLinesBrush { get; set; }
Property Value
Brush
ColumnWidth
Gets or sets the width of the columns.
CurrentCellInfo
Gets or sets the current cell info.
Declaration
public VirtualGridCellInfo CurrentCellInfo { get; set; }
Property Value
The current cell info.
CurrentCellStroke
Gets or sets the stroke brush of the current cell.
Declaration
public Brush CurrentCellStroke { get; set; }
Property Value
Brush
DataProvider
Gets or sets the data provider.
Declaration
public DataProvider DataProvider { get; set; }
Property Value
EditTriggers
Gets or sets the edit triggers.
Declaration
public VirtualGridEditTriggers EditTriggers { get; set; }
Property Value
The edit triggers.
FilterIconBackground
Gets or sets the filter icon background brush.
Declaration
public Brush FilterIconBackground { get; set; }
Property Value
Brush
FilterIconBackgroundFiltered
Gets or sets the filter icon background brush when the column is filtered.
Declaration
public Brush FilterIconBackgroundFiltered { get; set; }
Property Value
Brush
HorizontalLinesBrush
Gets or sets the horizontal lines' stroke brush.
Declaration
public Brush HorizontalLinesBrush { get; set; }
Property Value
Brush
InitialColumnCount
Gets or sets the initial column count.
InitialRowCount
Gets or sets the initial row count.
IsFilterable
Gets or sets a value that indicates whether programmatic and UI filtering is possible.
IsFilteringDeferred
Gets or sets a value that indicates whether deferred filtering is enabled.
IsSortable
Gets or sets a value that indicates whether programmatic and UI sorting is possible.
KeyboardCommandProvider
Gets the keyboard command provider.
Declaration
public IKeyboardCommandProvider KeyboardCommandProvider { get; set; }
Property Value
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
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.
PendingCommands
Gets all pending commands.
PinnedCellBackground
Gets or sets the cells' background when cells are pinned.
Declaration
public Brush PinnedCellBackground { get; set; }
Property Value
Brush
PinnedCellForeground
Gets or sets the cells' foreground when cells are pinned.
Declaration
public Brush PinnedCellForeground { get; set; }
Property Value
Brush
PinnedRowHeaderBackground
Gets or sets the pinned row headers' background.
Declaration
public Brush PinnedRowHeaderBackground { get; set; }
Property Value
Brush
RowAlternationCount
Gets or sets the alternation step for rows.
RowHeaderBackground
Gets or sets the row headers' background.
Declaration
public Brush RowHeaderBackground { get; set; }
Property Value
Brush
RowHeaderForeground
Gets or sets the row header's foreground.
Declaration
public Brush RowHeaderForeground { get; set; }
Property Value
Brush
RowHeaderLinesBrush
Gets or sets the row header lines' stroke brush.
Declaration
public Brush RowHeaderLinesBrush { get; set; }
Property Value
Brush
RowHeaderWidth
Gets or sets the width of the row headers.
RowHeight
Gets or sets the height of the rows.
SelectedCells
Gets the selected cells.
Declaration
public IList<VirtualGridCellInfo> SelectedCells { get; }
Property Value
SelectedIndex
Gets or sets the selected index of RadVirtualGrid.
SelectedIndexes
Gets the selected indexes.
Declaration
public IEnumerable<int> SelectedIndexes { get; }
Property Value
SelectionBrush
Gets or sets a value that indicates the selection brush.
Declaration
public Brush SelectionBrush { get; set; }
Property Value
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
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
ShouldCreateAutomationPeer
Gets or sets a value indicating whether automation peers for the RadVirtualGrid should be created.
Declaration
public bool ShouldCreateAutomationPeer { get; set; }
Property Value
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.
ShowDistinctFilters
Gets or sets a value that indicates whether distinct filters are visible.
ShowFieldFilters
Gets or sets a value that indicates whether filed filters are visible.
SortIconBackground
Gets or sets a value that indicates the background of the sort icon.
Declaration
public Brush SortIconBackground { get; set; }
Property Value
Brush
SortedHeaderBackground
Gets or sets the headers' background when the respective columns are sorted.
Declaration
public Brush SortedHeaderBackground { get; set; }
Property Value
Brush
SortedHeaderForeground
Gets or sets the headers' foreground when the respective columns are sorted.
Declaration
public Brush SortedHeaderForeground { get; set; }
Property Value
Brush
VerticalLinesBrush
Gets or sets the vertical lines' stroke brush.
Declaration
public Brush VerticalLinesBrush { get; set; }
Property Value
Brush
Methods
ApplyFilterDescriptorChanges(ColumnFilterDescriptor)
Propagates filter descriptor changes.
Declaration
protected virtual void ApplyFilterDescriptorChanges(ColumnFilterDescriptor filterDescriptor)
Parameters
filterDescriptor
BeginEdit(int, int)
Causes the RadVirtualGrid to enter editing mode for a given cell coordinates, unless the data grid is already in editing mode.
BeginInsert()
Causes the RadVirtualGrid to show new row and enter into EditMode.
Declaration
public void BeginInsert()
CallFiltered(IEnumerable<IFilterDescriptor>, IEnumerable<IFilterDescriptor>, int)
Generates FilteredEventArgs and invokes the FilterDescriptorPrepared event.
Declaration
protected virtual void CallFiltered(IEnumerable<IFilterDescriptor> added, IEnumerable<IFilterDescriptor> removed, int columnIndex)
Parameters
added
IEnumerable<IFilterDescriptor>
removed
IEnumerable<IFilterDescriptor>
columnIndex
CallFiltering(IEnumerable<IFilterDescriptor>, IEnumerable<IFilterDescriptor>, int)
Generates FilteringEventArgs and invokes the FilterDescriptorPreparing event.
Declaration
protected virtual bool CallFiltering(IEnumerable<IFilterDescriptor> added, IEnumerable<IFilterDescriptor> removed, int columnIndex)
Parameters
added
IEnumerable<IFilterDescriptor>
removed
IEnumerable<IFilterDescriptor>
columnIndex
Returns
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(int)
Clears the filter descriptors for the given column and resets its filtering control.
Declaration
public virtual void ClearFiltersForColumn(int columnIndex)
Parameters
columnIndex
CloseFilteringControl()
Closes the filtering UI.
Declaration
public void CloseFilteringControl()
CopyToClipboard()
Copies RadVirtualGrid selected cells to clipboard.
Declaration
public void CopyToClipboard()
ExecutePendingCommand()
Executes all pending commands in a sequence.
Declaration
public void ExecutePendingCommand()
FilterColumn(int)
Invokes the filtering UI for a specific column.
FitColumnWidthToContent(int)
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
columnIndex
Returns
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.
GetColumnIndexAtMousePosition(CanvasInputBorder)
Returns the index of a column for a given mouse position.
Declaration
public int GetColumnIndexAtMousePosition(CanvasInputBorder canvasInputBorder)
Parameters
canvasInputBorder
Returns
GetFilterDescriptorForColumn(int)
Gets the ColumnFilterDescriptor for a specific column.
Declaration
public ColumnFilterDescriptor GetFilterDescriptorForColumn(int columnIndex)
Parameters
columnIndex
Returns
GetFilteringControlForColumn(int)
Gets the FilteringControl for a specific column.
Declaration
public FilteringControl GetFilteringControlForColumn(int columnIndex)
Parameters
columnIndex
Returns
GetRowIndexAtMousePosition(CanvasInputBorder)
Returns the index of a row for a given mouse position.
Declaration
public int GetRowIndexAtMousePosition(CanvasInputBorder canvasInputBorder)
Parameters
canvasInputBorder
Returns
GetSortDescriptorForColumn(int)
Gets the ColumnSortDescriptor for a specific column.
Declaration
public ColumnSortDescriptor GetSortDescriptorForColumn(int columnIndex)
Parameters
columnIndex
Returns
InsertNewColumnAtIndex(int)
Increases the table capacity by adding a column on the given index.
InsertNewRowAtIndex(int)
Increases the table capacity by adding a row on the given index.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call .
Declaration
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Returns an automation peer for RadVirtualGrid.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
AutomationPeer
OnDistinctValuesLoading(DistinctValuesLoadingEventArgs)
Invoked DataProvider.DistinctValuesLoading if DataProvider is available, or raises DistinctValuesLoading instead.
Declaration
protected virtual void OnDistinctValuesLoading(DistinctValuesLoadingEventArgs e)
Parameters
e
OnFieldFilterEditorCreated(FieldFilterEditorCreatedEventArgs)
Declaration
protected virtual void OnFieldFilterEditorCreated(FieldFilterEditorCreatedEventArgs args)
Parameters
args
OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs)
Invokes DataProvider.FilterOperatorsLoading if DataProvider is available or raises FilterOperatorsLoading instead.
Declaration
protected void OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)
Parameters
e
OnFiltered(FilteredEventArgs)
Invokes the FilterDescriptorPrepared event.
Declaration
protected virtual void OnFiltered(FilteredEventArgs e)
Parameters
e
OnFiltering(FilteringEventArgs)
Invokes the FilterDescriptorsPreparing event.
Declaration
protected virtual void OnFiltering(FilteringEventArgs e)
Parameters
e
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
e
The RoutedEventArgs that contains the event data.
OnPreviewKeyDown(KeyEventArgs)
Occurs when KeyDown event is raised.
Declaration
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters
e
KeyEventArgs
OnSelectedCellsChanging(VirtualGridSelectedCellsChangingEventArgs)
Raises the SelectedCellsChangingEvent event.
Declaration
protected virtual void OnSelectedCellsChanging(VirtualGridSelectedCellsChangingEventArgs args)
Parameters
args
VirtualGridSelectedCellsChangingEventArgs
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
e
OnSorting(SortingEventArgs)
Invokes DataProvider.SortDescriptorPreparing if DataProvider is present or invokes the SortDescriptorPreparing event instead.
Declaration
protected virtual void OnSorting(SortingEventArgs e)
Parameters
e
OnTextInput(TextCompositionEventArgs)
Executed when text has been input.
Declaration
protected override void OnTextInput(TextCompositionEventArgs e)
Parameters
e
TextCompositionEventArgs
Event args.
PinColumnLeft(int)
Pins the column left.
PinColumnRight(int)
Pins the column right.
Declaration
public void PinColumnRight(int columnIndex)
Parameters
columnIndex
PinRowBottom(int)
Pins the row bottom.
PinRowTop(int)
Pins the row top.
PushCellValue(int, int, object)
Updates VirtualGrid with the given value. It also needs to be persisted in the data source.
RemoveColumnAtIndex(int)
Reduces the table capacity by removing a column on the given index.
RemoveRowAtIndex(int)
Reduces the table capacity by removing a row on the given index.
Reset()
Resets the control to its initial visual state.
Declaration
public void Reset()
Reset(int, int)
Resets the control to an initial visual state with the given row count and column count.
ScrollColumnIndexIntoViewAsync(int, 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
columnIndex
The column index to scroll into view.
scrollFinishedCallback
The method to execute when scrolling has finished.
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(int, int, 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
rowIndex
The row index to scroll into view.
columnIndex
The column index to scroll into view.
scrollFinishedCallback
The method to execute when scrolling has finished.
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(int, 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
rowIndex
The row index to scroll into view.
scrollFinishedCallback
The method to execute when scrolling has finished.
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(CellRegion)
Selects specified region of cells.
Declaration
public void SelectCellRegion(CellRegion cellRegion)
Parameters
cellRegion
SelectCellRegion(IEnumerable<CellRegion>)
Selects specified region of cells.
Declaration
public void SelectCellRegion(IEnumerable<CellRegion> cellRegions)
Parameters
cellRegions
SortColumn(int)
Invokes the sorting UI for a specific column.
ToggleIndexSelection(int)
Selects the given index if it is not selected, or deselects if it is already selected.
UnpinColumn(int)
Unpins the column with the given index.
UnpinRow(int)
Unpins the row with the given index.
UnselectAll()
Clears the current selection state.
Declaration
public void UnselectAll()
UnselectCellRegion(CellRegion)
Deselects specified region of cells.
Declaration
public void UnselectCellRegion(CellRegion cellRegion)
Parameters
cellRegion
UnselectCellRegion(IEnumerable<CellRegion>)
Deselects specified region of cells.
Declaration
public void UnselectCellRegion(IEnumerable<CellRegion> cellRegions)
Parameters
cellRegions
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 Value
CellEditEnded
Occurs when an edit operation is finished.
Declaration
public event EventHandler<CellEditEndedEventArgs> CellEditEnded
Event Value
CellTemplateNeeded
Occurs when RadVirtualGrid fetches the DataTemplate for a given cell.
Declaration
public event EventHandler<CellTemplateEventArgs> CellTemplateNeeded
Event Value
CellToolTipNeeded
Occurs when RadVirtualGrid fetches the value for a cell's tooltip.
Declaration
public event EventHandler<VirtualGridCellToolTipEventArgs> CellToolTipNeeded
Event Value
CellValueNeeded
Occurs when RadVirtualGrid fetches the value for a cell.
Declaration
public event EventHandler<CellValueEventArgs> CellValueNeeded
Event Value
Copied
Occurs after the selected cells of the RadVirtualGrid were copied to the Clipboard.
Declaration
public event EventHandler<RadRoutedEventArgs> Copied
Event Value
Copying
Occurs before the selected cells of the RadVirtualGrid are copied to the Clipboard.
Declaration
public event EventHandler<VirtualGridClipboardEventArgs> Copying
Event Value
CopyingCellClipboardContent
Occurs before a cell is copied to the Clipboard.
Declaration
public event EventHandler<VirtualGridCellClipboardEventArgs> CopyingCellClipboardContent
Event Value
CurrentCellChanged
Occurs when the current cell is changed.
Declaration
public event EventHandler<VirtualGridCurrentCellChangedEventArgs> CurrentCellChanged
Event Value
DataMemberNeeded
Occurs when data-related information for a given column is needed.
Declaration
public event EventHandler<DataMemberEventArgs> DataMemberNeeded
Event Value
Deleted
Occurs when VirtualGrid's selected indexes are deleted.
Declaration
public event EventHandler<VirtualGridDeletedEventArgs> Deleted
Event Value
Deleting
Occurs when deleting the VirtualGrid's selected indexes.
Declaration
public event EventHandler<VirtualGridDeletingEventArgs> Deleting
Event Value
DistinctValuesLoading
Occurs when distinct values are being loaded.
Declaration
public event EventHandler<DistinctValuesLoadingEventArgs> DistinctValuesLoading
Event Value
EditorNeeded
Occurs when a cell is edited and the editor property value gets changed.
Declaration
public event EventHandler<EditorNeededEventArgs> EditorNeeded
Event Value
EditorValueChanged
Occurs when a cell is edited and an editor is required.
Declaration
public event EventHandler<CellValueEventArgs> EditorValueChanged
Event Value
FieldFilterEditorCreated
Occurs when filed filter editor is created.
Declaration
public event EventHandler<FieldFilterEditorCreatedEventArgs> FieldFilterEditorCreated
Event Value
FilterDescriptorsPrepared
Occurs when filter descriptors for the filtered column are ready and filtering operation will be executed.
Declaration
public event EventHandler<FilteredEventArgs> FilterDescriptorsPrepared
Event Value
FilterDescriptorsPreparing
Occurs when filter descriptors for the filtered column are being prepared.
Declaration
public event EventHandler<FilteringEventArgs> FilterDescriptorsPreparing
Event Value
FilterOperatorsLoading
Occurs when filter operators are being loaded.
Declaration
public event EventHandler<FilterOperatorsLoadingEventArgs> FilterOperatorsLoading
Event Value
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 Value
HeaderSizeNeeded
Occurs when size for a header cell is needed.
Declaration
public event EventHandler<HeaderSizeEventArgs> HeaderSizeNeeded
Event Value
HeaderValueNeeded
Occurs when header cell values is needed.
Declaration
public event EventHandler<HeaderValueEventArgs> HeaderValueNeeded
Event Value
OverlayBrushesNeeded
Occurs when the set of brushes that will be used for background customization is needed.
Declaration
public event EventHandler<OverlayBrushesEventArgs> OverlayBrushesNeeded
Event Value
SelectedCellsChanged
Event that fires when the SelectedCells collection is changed.
Declaration
public event EventHandler<VirtualGridSelectedCellsChangedEventArgs> SelectedCellsChanged
Event Value
SelectedCellsChanging
Event that fires when the SelectedCells collection is about to change.
Declaration
public event EventHandler<VirtualGridSelectedCellsChangingEventArgs> SelectedCellsChanging
Event Value
SelectionChanged
Event that fires when the selection of RadVirtualGrid is changed.
Declaration
public event SelectionChangedEventHandler SelectionChanged
Event Value
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 Value
SortDescriptorPreparing
Occurs when sort descriptor for the sorted column is being prepared.
Declaration
public event EventHandler<SortingEventArgs> SortDescriptorPreparing
Event Value