Class

RadVirtualGrid

Declaration

public RadVirtualGrid()

Represents the constant value for the filter row index.

Declaration

public const int FilterRowIndex = -3

Field Value

Represents the constant value for the header row index.

Declaration

public const int HeaderRowIndex = -1

Field Value

Represents the constant value for the indent cell index.

Declaration

public const int IndentCellIndex = -1

Field Value

Represents the constant value for the new row index.

Declaration

public const int NewRowIndex = -2

Field Value

Gets the currently active cell editor when the grid is in edit mode, providing access to the input control being used for editing.

Declaration

public IInputEditor ActiveEditor { get; }

Property Value

Gets or sets a value indicating whether the add new row for inserting new records is visible at the bottom of the grid.

Declaration

public bool AllowAddNewRow { get; set; }

Property Value

Gets or sets a value indicating whether right-clicking on a data cell displays the default data cell context menu with cut, copy, paste, and other options.

Declaration

public bool AllowCellContextMenu { get; set; }

Property Value

Gets or sets a value indicating whether right-clicking on a header cell displays the default header cell context menu with sorting and filtering options.

Declaration

public bool AllowColumnHeaderContextMenu { get; set; }

Property Value

Gets or sets a value indicating whether users can resize columns through the grid user interface by dragging the column borders.

Declaration

public bool AllowColumnResize { get; set; }

Property Value

Gets or sets a value indicating whether the Copy option in the context menu and the Ctrl+C keyboard shortcut are available to users for copying cell content.

Declaration

public bool AllowCopy { get; set; }

Property Value

Gets or sets a value indicating whether the Cut option in the context menu and the Ctrl+X keyboard shortcut are available to users for cutting cell content.

Declaration

public bool AllowCut { get; set; }

Property Value

Gets or sets a value indicating whether users can delete rows using the Delete key or through the context menu.

Declaration

public bool AllowDelete { get; set; }

Property Value

Gets or sets a value indicating whether users can edit the values in data cells by double-clicking or pressing F2.

Declaration

public bool AllowEdit { get; set; }

Property Value

Gets or sets a value indicating whether the filter row for column-based filtering is visible below the header row.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Gets or sets a value indicating whether users can sort by multiple columns simultaneously to create complex sorting scenarios.

Declaration

public bool AllowMultiColumnSorting { get; set; }

Property Value

Gets or sets a value indicating whether the Paste option in the context menu and the Ctrl+V keyboard shortcut are available to users for pasting cell content.

Declaration

public bool AllowPaste { get; set; }

Property Value

Gets or sets a value indicating whether users can resize rows through the grid user interface by dragging the row borders.

Declaration

public bool AllowRowResize { get; set; }

Property Value

Gets or sets a value indicating whether users can sort columns by clicking the column header or through the header context menu.

Declaration

public bool AllowSorting { get; set; }

Property Value

Gets or sets a value indicating how column widths are automatically determined, such as fitting to content, filling available space, or using fixed widths.

Declaration

public VirtualGridAutoSizeColumnsMode AutoSizeColumnsMode { get; set; }

Property Value

Gets or sets the method for entering edit mode, determining how users can start editing a cell (keystroke, F2, double-click, etc.).

Declaration

public RadVirtualGridBeginEditMode BeginEditMode { get; set; }

Property Value

Gets or sets the total number of columns to be displayed in the grid, which determines the grid's horizontal structure.

Declaration

public int ColumnCount { get; set; }

Property Value

Gets or sets the currently active cell in the grid, which is the cell that has focus and can be edited.

Declaration

[Browsable(false)]
public VirtualGridCellInfo CurrentCell { get; set; }

Property Value

Gets the default size of the control when no explicit size is specified.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets a value indicating whether even and odd rows display with different background colors to improve data readability.

Declaration

public bool EnableAlternatingRowColor { get; set; }

Property Value

Gets or sets a value indicating whether there is a visual indication, such as highlighting, for the row currently under the mouse cursor.

Declaration

public bool EnableHotTracking { get; set; }

Property Value

Gets or sets a value indicating whether data is presented in chunks or pages to the user, which improves performance with large datasets.

Declaration

public bool EnablePaging { get; set; }

Property Value

Gets or sets the behavior of the Enter key when pressed while in edit mode, such as moving to the next cell or ending the edit operation.

Declaration

public RadVirtualGridEnterKeyMode EnterKeyMode { get; set; }

Property Value

Gets the collection of filter descriptors currently applied to the grid, which define the filtering criteria for data display.

Declaration

[Browsable(false)]
public FilterDescriptorCollection FilterDescriptors { get; }

Property Value

Gets a value indicating whether the grid is currently in edit mode with an active cell editor.

Declaration

public bool IsInEditMode { get; }

Property Value

Gets the main VirtualGridViewInfo instance that contains the primary data view configuration and settings for the grid.

Declaration

public VirtualGridViewInfo MasterViewInfo { get; }

Property Value

Gets or sets a value indicating whether multiple cells, rows, or columns can be selected simultaneously using Ctrl+Click or Shift+Click combinations.

Declaration

public bool MultiSelect { get; set; }

Property Value

Gets or sets the zero-based index of the page currently displayed in the grid when paging is enabled.

Declaration

public int PageIndex { get; set; }

Property Value

Gets or sets the number of rows displayed per page when paging is enabled, which determines how many records are visible at once.

Declaration

public int PageSize { get; set; }

Property Value

Gets or sets the total number of data rows to be displayed in the grid, which is used for virtual scrolling and paging calculations.

Declaration

public int RowCount { get; set; }

Property Value

Gets a VirtualGridSelection object that provides a comprehensive API for programmatically manipulating cell and row selection in the grid.

Declaration

[Browsable(false)]
public VirtualGridSelection Selection { get; }

Property Value

Gets or sets a value indicating how cells are selected in the grid, either individual cells, entire rows, or entire columns.

Declaration

public VirtualGridSelectionMode SelectionMode { get; set; }

Property Value

Gets or sets a value indicating whether the header row containing column headers is visible in the grid.

Declaration

public bool ShowHeaderRow { get; set; }

Property Value

Gets or sets a value indicating whether a "No data to display" message is shown in the grid when no data is loaded or all data is filtered out.

Declaration

public bool ShowNoDataText { get; set; }

Property Value

Gets the collection of sort descriptors currently applied to the grid, which define the sorting criteria for data display.

Declaration

[Browsable(false)]
public SortDescriptorCollection SortDescriptors { get; }

Property Value

Gets or sets a value indicating whether the TAB key moves focus to the next control in the tab order rather than navigating to the next cell within the grid.

Declaration

public bool StandardTab { get; set; }

Property Value

Gets an instance of VirtualGridTableElement that contains and manages all the row and column visual elements in the grid.

Declaration

public VirtualGridTableElement TableElement { get; }

Property Value

Gets the total number of pages available when paging is enabled, calculated based on the total row count and page size.

Declaration

public int TotalPages { get; }

Property Value

Gets or sets a value indicating whether child views in hierarchical data display have fixed size or dynamically adjust based on the number of rows they contain.

Declaration

public bool UseScrollbarsInHierarchy { get; set; }

Property Value

Gets the instance of RadVirtualGridElement that represents the main element in the element tree and encapsulates the core functionality of RadVirtualGrid.

Declaration

public RadVirtualGridElement VirtualGridElement { get; }

Property Value

Gets or sets the serialization information for RadVirtualGrid used by Save/Load layout methods to persist grid settings to and from XML format. When set to null, the default serialization info from GetDefaultXmlSerializationInfo() is used.

Declaration

[Browsable(false)]
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }

Property Value

Initiates the editing process for the currently selected cell, making it available for user input.

Declaration

public void BeginEdit()

Suspends layout updates for the virtual grid to improve performance during bulk operations and prevent unnecessary redraws.

Declaration

public void BeginUpdate()

Automatically adjusts the width of all columns in the master view to fit their content, expanding or shrinking columns based on the space required by the text in the cells.

Declaration

public void BestFitColumns()

Automatically adjusts the width of all columns in the specified view to fit their content, expanding or shrinking columns based on the space required by the text in the cells.

Declaration

public void BestFitColumns(VirtualGridViewInfo viewInfo)

Parameters

Cancels the editing process without committing any changes, reverting the cell value to its original state.

Declaration

public bool CancelEdit()

Returns

Creates and initializes the child elements of the virtual grid control by adding the main grid element to the parent element.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates and returns a new instance of RadVirtualGridElement that serves as the main element for this control.

Declaration

protected virtual RadVirtualGridElement CreateElement()

Returns

Ends the editing process and attempts to commit any changes made to the cell value, applying validation if necessary.

Declaration

public bool EndEdit()

Returns

Resumes layout updates for the virtual grid and triggers any pending layout operations that were deferred during the update suspension.

Declaration

public void EndUpdate()

Gets the default serialization information for RadVirtualGrid used by Save/Load layout methods to persist grid settings to and from XML format.

Declaration

public virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()

Returns

Determines whether the specified key combination represents an input key that should be processed by the grid for navigation and editing operations.

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides RadControl.IsInputKey(Keys)

Loads RadVirtualGrid layout configuration including properties and sub-objects from an XML stream using the serialization information from XmlSerializationInfo.

Declaration

public virtual void LoadLayout(Stream stream)

Parameters

Loads RadVirtualGrid layout configuration including properties and sub-objects from XML data using the specified XML reader and the serialization information from XmlSerializationInfo.

Declaration

public virtual void LoadLayout(XmlReader xmlReader)

Parameters

Loads RadVirtualGrid layout configuration including properties and sub-objects from an XML file using the specified file path and the serialization information from XmlSerializationInfo.

Declaration

public virtual void LoadLayout(string fileName)

Parameters

Raises the KeyDown event and handles keyboard input for cell navigation, editing operations, and special key combinations.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Raises the KeyPress event and handles character input for cell editing and data entry operations.

Declaration

protected override void OnKeyPress(KeyPressEventArgs e)

Parameters

Overrides RadControl.OnKeyPress(KeyPressEventArgs)

Raises the KeyUp event and handles keyboard input release, managing navigation between cells when editing with text box editors.

Declaration

protected override void OnKeyUp(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyUp(KeyEventArgs)

Raises the Layout event and synchronizes the grid rows to ensure proper visual layout.

Declaration

protected override void OnLayout(LayoutEventArgs e)

Parameters

Overrides RadControl.OnLayout(LayoutEventArgs)

Raises the LayoutLoaded event when the grid layout has been successfully loaded from XML data.

Declaration

protected void OnLayoutLoaded(object sender, LayoutLoadedEventArgs e)

Parameters

Raises the MouseClick event and handles single-click interactions with cells, triggering the CellClick event for valid cell clicks.

Declaration

protected override void OnMouseClick(MouseEventArgs e)

Parameters

Overrides Control.OnMouseClick(MouseEventArgs)

Raises the MouseDoubleClick event and handles double-click interactions with cells, potentially triggering cell-specific actions.

Declaration

protected override void OnMouseDoubleClick(MouseEventArgs e)

Parameters

Overrides Control.OnMouseDoubleClick(MouseEventArgs)

Raises the MouseDown event and handles mouse down interactions with the grid, recording the mouse down location for click detection.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseDown(MouseEventArgs)

Raises the MouseMove event and handles mouse movement over the grid for tracking, selection, and resize operations.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseMove(MouseEventArgs)

Raises the MouseUp event and handles mouse button release interactions with the grid.

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseUp(MouseEventArgs)

Raises the MouseWheel event and handles mouse wheel scrolling for vertical navigation through the grid.

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseWheel(MouseEventArgs)

Raises the Validating event and performs validation of the current cell and row if the grid is in edit mode.

Declaration

protected override void OnValidating(CancelEventArgs e)

Parameters

Overrides Control.OnValidating(CancelEventArgs)

Processes dialog keys such as Tab and Escape, handling cell navigation and edit mode operations according to the grid's input behavior settings.

Declaration

protected override bool ProcessDialogKey(Keys keyData)

Parameters

Returns

Overrides Control.ProcessDialogKey(Keys)

Saves the current RadVirtualGrid layout configuration including properties and sub-objects to XML format using the specified stream and the serialization information from XmlSerializationInfo. The stream is left open after the operation.

Declaration

public virtual void SaveLayout(Stream stream)

Parameters

Saves the current RadVirtualGrid layout configuration including properties and sub-objects to XML format using the specified XML writer and the serialization information from XmlSerializationInfo.

Declaration

public virtual void SaveLayout(XmlWriter xmlWriter)

Parameters

Saves the current RadVirtualGrid layout configuration including properties and sub-objects to an XML file using the specified file path and the serialization information from XmlSerializationInfo.

Declaration

public virtual void SaveLayout(string fileName)

Parameters

Selects all visible cells in the grid according to the current selection mode and multi-select settings.

Declaration

public void SelectAll()

Selects the cell at the specified row and column indices in the grid master view and clears any previous selection.

Declaration

public void SelectCell(int row, int column)

Parameters

Selects the cell at the specified row and column indices in the specified view and clears any previous selection.

Declaration

public void SelectCell(int row, int column, VirtualGridViewInfo viewInfo)

Parameters

Occurs when a cell is clicked with the mouse, providing information about the clicked cell and mouse event details.

Declaration

public event VirtualGridCellElementEventHandler CellClick

Event Value

Occurs when a cell is double-clicked with the mouse, typically triggering edit mode or other cell-specific actions.

Declaration

public event EventHandler CellDoubleClick

Event Value

Occurs when the editor for a cell has been initialized and is ready for customization or configuration.

Declaration

public event VirtualGridCellEditorInitializedEventHandler CellEditorInitialized

Event Value

Occurs when a cell element is created or updated and needs custom formatting or styling applied.

Declaration

public event VirtualGridCellElementEventHandler CellFormatting

Event Value

Occurs when the mouse cursor is moved over a cell, providing continuous feedback about mouse position relative to grid cells.

Declaration

public event VirtualGridCellElementMouseEventHandler CellMouseMove

Event Value

Occurs after a cell has been painted by the system, allowing custom drawing operations on top of the cell content.

Declaration

public event VirtualGridCellPaintEventHandler CellPaint

Event Value

Occurs before a cell value is validated, providing an opportunity to perform custom validation logic and cancel invalid changes.

Declaration

public event VirtualGridCellValidatingEventHandler CellValidating

Event Value

Occurs when a cell is displayed and its content needs to be populated, allowing data binding in virtual mode.

Declaration

public event VirtualGridCellValueNeededEventHandler CellValueNeeded

Event Value

Occurs when a cell value has been edited and needs to be stored back to the data source in virtual mode.

Declaration

public event VirtualGridCellValuePushedEventHandler CellValuePushed

Event Value

Occurs after the width of a column has changed, indicating that the column has been successfully resized.

Declaration

public event VirtualGridColumnEventHandler ColumnWidthChanged

Event Value

Occurs before the width of a column changes, providing an opportunity to validate or cancel the resize operation.

Declaration

public event VirtualGridColumnWidthChangingEventHandler ColumnWidthChanging

Event Value

Occurs when the context menu is about to be opened, allowing customization of menu items or cancellation of the menu display.

Declaration

public event VirtualGridContextMenuOpeningEventHandler ContextMenuOpening

Event Value

Occurs when cell content is being copied to the clipboard, allowing modification of the copy operation or the content being copied.

Declaration

public event VirtualGridClipboardEventHandler Copying

Event Value

Occurs when a new cell element needs to be created, allowing customization of the cell element type or properties.

Declaration

public event VirtualGridCreateCellEventHandler CreateCellElement

Event Value

Occurs when a new row element needs to be created, allowing customization of the row element type or properties.

Declaration

public event VirtualGridCreateRowEventHandler CreateRowElement

Event Value

Occurs after the current cell has changed to a different cell, indicating that navigation has completed.

Declaration

public event EventHandler CurrentCellChanged

Event Value

Occurs before the current cell changes to a different cell, providing an opportunity to cancel the navigation.

Declaration

public event VirtualGridCellInfoCancelEventHandler CurrentCellChanging

Event Value

Occurs when an editor is required for a cell, allowing custom editor selection or configuration based on cell content or type.

Declaration

public event VirtualGridEditorRequiredEventHandler EditorRequired

Event Value

Occurs when the filter descriptors collection changes, indicating that the filtering criteria have been modified.

Declaration

public event VirtualGridEventHandler FilterChanged

Event Value

Occurs when the grid layout has been successfully loaded from XML, allowing post-load processing and configuration.

Declaration

[Browsable(true)]
public event LayoutLoadedEventHandler LayoutLoaded

Event Value

Occurs after the current page index has changed when paging is enabled, indicating that a different page is now displayed.

Declaration

public event VirtualGridEventHandler PageChanged

Event Value

Occurs before the current page index changes when paging is enabled, allowing cancellation of the page navigation.

Declaration

public event VirtualGridPageChangingEventHandler PageChanging

Event Value

Occurs when content is about to be pasted from the clipboard into cells, allowing modification of the paste operation or the content being pasted.

Declaration

public event VirtualGridClipboardEventHandler Pasting

Event Value

Occurs when the grid needs to determine whether a row has child rows in hierarchical data scenarios, allowing dynamic hierarchy detection.

Declaration

public event VirtualGridQueryHasChildRowsEventHandler QueryHasChildRows

Event Value

Occurs after a hierarchical row has been successfully collapsed to hide its child rows.

Declaration

public event VirtualGridRowExpandedEventHandler RowCollapsed

Event Value

Occurs before a hierarchical row is collapsed to hide its child rows, allowing cancellation of the operation.

Declaration

public event VirtualGridRowExpandingEventHandler RowCollapsing

Event Value

Occurs after a hierarchical row has been successfully expanded to show its child rows.

Declaration

public event VirtualGridRowExpandedEventHandler RowExpanded

Event Value

Occurs before a hierarchical row is expanded to show its child rows, allowing cancellation of the operation.

Declaration

public event VirtualGridRowExpandingEventHandler RowExpanding

Event Value

Occurs when a row element is created or updated and needs custom formatting or styling applied.

Declaration

public event VirtualGridRowElementEventHandler RowFormatting

Event Value

Occurs after the height of a row has changed, indicating that the row has been successfully resized.

Declaration

public event VirtualGridRowEventHandler RowHeightChanged

Event Value

Occurs before the height of a row changes, providing an opportunity to validate or cancel the resize operation.

Declaration

public event VirtualGridRowHeightChangingEventHandler RowHeightChanging

Event Value

Occurs after a row has been painted by the system, allowing custom drawing operations on top of the entire row.

Declaration

public event VirtualGridRowPaintEventHandler RowPaint

Event Value

Occurs after a row has been successfully validated, indicating that all validation rules have passed.

Declaration

public event VirtualGridRowEventHandler RowValidated

Event Value

Occurs before a row is validated, providing an opportunity to perform custom validation logic across multiple cells in the row.

Declaration

public event VirtualGridRowValidatingEventHandler RowValidating

Event Value

Occurs after the selection has changed in the grid, indicating that different cells or rows are now selected.

Declaration

public event EventHandler SelectionChanged

Event Value

Occurs before the selection changes in the grid, providing an opportunity to validate or cancel the selection change.

Declaration

public event VirtualGridSelectionChangingEventHandler SelectionChanging

Event Value

Occurs when the sort descriptors collection changes, indicating that the sorting criteria have been modified.

Declaration

public event VirtualGridEventHandler SortChanged

Event Value

Occurs when a user successfully adds a new row to the grid through the new row interface.

Declaration

public event VirtualGridNewRowEventHandler UserAddedRow

Event Value

Occurs when a user successfully deletes one or more rows from the grid.

Declaration

public event VirtualGridRowsEventHandler UserDeletedRow

Event Value

Occurs after the value of a cell has been successfully changed and committed.

Declaration

public event EventHandler ValueChanged

Event Value

Occurs before the value of a cell is changed, providing an opportunity to validate or modify the new value.

Declaration

public event ValueChangingEventHandler ValueChanging

Event Value

Occurs when a property of any view info object changes, providing notification of configuration or state changes in the grid views.

Declaration

public event VirtualGridViewInfoPropertyChangedEventHandler ViewInfoPropertyChanged

Event Value