Class

RadVirtualGridElement

Initializes a new instance of the RadVirtualGridElement class.

Declaration

public RadVirtualGridElement()

Gets the currently active editor when the grid is in edit mode.

Declaration

public IInputEditor ActiveEditor { get; }

Property Value

Gets or sets a value indicating whether the add new row is visible.

Declaration

public bool AllowAddNewRow { get; set; }

Property Value

Gets or sets a value indicating whether right-clicking on a data cell will show the default data cell context menu.

Declaration

public bool AllowCellContextMenu { get; set; }

Property Value

Gets or sets a value indicating whether right-clicking on a header cell will show the default header cell context menu.

Declaration

public bool AllowColumnHeaderContextMenu { get; set; }

Property Value

Gets or sets a value indicating whether users can resize columns through the grid UI.

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 shortcut will be available to the user.

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 shortcut will be available to the user.

Declaration

public bool AllowCut { get; set; }

Property Value

Gets or sets a value indicating whether users can delete rows.

Declaration

public bool AllowDelete { get; set; }

Property Value

Gets or sets a value indicating whether users can edit the values in data cells.

Declaration

public bool AllowEdit { get; set; }

Property Value

Gets or sets a value indicating whether the filter row is visible.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Gets or sets a value indicating whether the users can sort by more than one column.

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 shortcut will be available to the user.

Declaration

public bool AllowPaste { get; set; }

Property Value

Gets or sets a value indicating whether users can resize rows through the grid UI.

Declaration

public bool AllowRowResize { get; set; }

Property Value

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

Declaration

public bool AllowSorting { get; set; }

Property Value

Gets or sets the method for entering edit mode.

Declaration

public RadVirtualGridBeginEditMode BeginEditMode { get; set; }

Property Value

Gets or sets the total number of columns to be displayed in the grid.

Declaration

public int ColumnCount { get; set; }

Property Value

Gets or sets the default context menu.

Declaration

public RadDropDownMenu ContextMenu { get; set; }

Property Value

Gets or sets the current cell.

Declaration

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

Property Value

Gets or sets a value indicating whether event and odd rows will have a different back color.

Declaration

public bool EnableAlternatingRowColor { get; set; }

Property Value

Gets or sets a value indicating whether data is presented in chunks (pages) to the user.

Declaration

public bool EnablePaging { get; set; }

Property Value

Gets or sets the behavior of the Enter key when pressed while in edit mode.

Declaration

public RadVirtualGridEnterKeyMode EnterKeyMode { get; set; }

Property Value

Gets the filter descriptors currently applied to the grid.

Declaration

public FilterDescriptorCollection FilterDescriptors { get; }

Property Value

Gets or sets an instance of VirtualGridInputBehavior which handles user input.

Declaration

public VirtualGridInputBehavior InputBehavior { get; set; }

Property Value

Gets a value indicating whether the grid is in edit mode.

Declaration

public bool IsInEditMode { get; }

Property Value

Gets the main VirtualGridViewInfo instance of the grid.

Declaration

public VirtualGridViewInfo MasterViewInfo { get; }

Property Value

Gets or sets a value indicating whether multiple cells can be selected simultaneously.

Declaration

public bool MultiSelect { get; set; }

Property Value

Gets or sets the index of the page currently presented in the grid.

Declaration

public int PageIndex { get; set; }

Property Value

Gets or sets the number of rows shown per page when paging is enabled.

Declaration

public int PageSize { get; set; }

Property Value

Gets or sets the total number of rows to be displayed in the grid.

Declaration

public int RowCount { get; set; }

Property Value

Gets a VirtualGridSelection object which provides an API for manipulating the selection.

Declaration

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

Property Value

Gets or sets a value indicating how cells are selected.

Declaration

public VirtualGridSelectionMode SelectionMode { get; set; }

Property Value

Gets or sets a value indicating whether the header row is visible.

Declaration

public bool ShowHeaderRow { get; set; }

Property Value

Gets or sets a value indicating whether a message should be displayed in the grid when no data is loaded.

Declaration

public bool ShowNoDataText { get; set; }

Property Value

Gets the sort descriptors currently applied to the grid.

Declaration

public SortDescriptorCollection SortDescriptors { get; }

Property Value

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

Declaration

public bool StandardTab { get; set; }

Property Value

Gets an instance of VirtualGridTableElement which holds all rows and columns.

Declaration

public VirtualGridTableElement TableElement { get; }

Property Value

Gets the total number of pages when paging is enabled.

Declaration

public int TotalPages { get; }

Property Value

Gets or sets value indicating whether child views have fixed size [true] or depend on the number of rows they contain [false].

Declaration

public bool UseScrollbarsInHierarchy { get; set; }

Property Value

Starts the editing process for the current cell.

Declaration

public bool BeginEdit()

Returns

Starts the editing process for the specified cell.

Declaration

public virtual bool BeginEdit(VirtualGridCellElement currentCell)

Parameters

Returns

Suspends layout updates.

Declaration

public void BeginUpdate()

Widens / shrinks the column at the specified index in the specified view info based on the space required by the text in the cells.

Declaration

public void BestFitColumn(int columnIndex)

Parameters

Widens / shrinks the column at the specified index in the specified view info based on the space required by the text in the cells.

Declaration

public void BestFitColumn(int columnIndex, VirtualGridViewInfo viewInfo)

Parameters

Widens / shrinks all columns based on the space required by the text in the cells.

Declaration

public void BestFitColumns()

Widens / shrinks all columns in the specified view info based on the space required by the text in the cells.

Declaration

public void BestFitColumns(VirtualGridViewInfo viewInfo)

Parameters

Returns a value indicating whether the current editor can be closed.

Declaration

public virtual bool CanEndEdit()

Returns

Ends the editing process without committing any changes. Returns a value indicating whether the operation succeeded.

Declaration

public virtual bool CancelEdit()

Returns

Collapses the specified row.

Declaration

public bool CollapseRow(int rowIndex)

Parameters

Returns

Commits the value in the new row by firing the event.

Declaration

public void CommitNewRow()

Copies the content of the selected cells.

Declaration

public virtual bool CopySelection()

Returns

Copies the content of the specified cell region to the clipboard.

Declaration

public void CopyToClipboard(int startRow, int startColumn, int endRow, int endColumn, VirtualGridViewInfo viewInfo)

Parameters

Copies the content of the specified cell region to the clipboard.

Declaration

public void CopyToClipboard(int startRow, int startColumn, int endRow, int endColumn, VirtualGridViewInfo viewInfo, bool selectedOnly, bool cut)

Parameters

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates the table element.

Declaration

protected virtual VirtualGridTableElement CreateTableElement(RadVirtualGridElement virtualGridElement, VirtualGridViewInfo viewInfo)

Parameters

Returns

Cuts the content of the selected cells.

Declaration

public virtual bool CutSelection()

Returns

Deletes the rows specified in the first parameter from the specified view info.

Declaration

public void DeleteRow(IEnumerable<int> rowIndices, VirtualGridViewInfo viewInfo)

Parameters

Deletes the currently selected row.

Declaration

public bool DeleteSelectedRow()

Returns

Disposes the managed resources.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Fires when the DPI scale is changed.

Declaration

public override void DpiScaleChanged(SizeF scaleFactor)

Parameters

Overrides RadElement.DpiScaleChanged(SizeF)

Ends the editing process and tries to commit any changes made to the edit value. Returns a value indicating whether the operation succeeded.

Declaration

public virtual bool EndEdit()

Returns

Resumes layout updates.

Declaration

public void EndUpdate()

Ensures the cell defined by the row and column indices is visible in the current view.

Declaration

public void EnsureCellVisible(int rowIndex, int columnIndex)

Parameters

Ensures the cell defined by the row and column indices is visible in the current view.

Declaration

public void EnsureCellVisible(int rowIndex, int columnIndex, VirtualGridTableElement tableElement)

Parameters

Ensures the cell defined by the row and column indices is visible in the current view.

Declaration

public void EnsureCellVisible(int rowIndex, int columnIndex, VirtualGridViewInfo viewInfo)

Parameters

Ensures the row at the specified row index is visible in the current view.

Declaration

public void EnsureRowVisible(int rowIndex)

Parameters

Ensures the row at the specified row index is visible in the current view.

Declaration

public void EnsureRowVisible(int rowIndex, VirtualGridTableElement tableElement)

Parameters

Ensures the row at the specified row index is visible in the current view.

Declaration

public void EnsureRowVisible(int rowIndex, VirtualGridViewInfo viewInfo)

Parameters

Expands the specified row.

Declaration

public bool ExpandRow(int rowIndex)

Parameters

Returns

Attempts to find a visual cell element that represents the data on the specified row and column indices.

Declaration

public VirtualGridCellElement FindCellElement(int rowIndex, int columnIndex, VirtualGridViewInfo viewInfo)

Parameters

Returns

Gets the cell element for the specified row and column indices and view info.

Declaration

public VirtualGridCellElement GetCellElement(int rowIndex, int columnIndex, VirtualGridTableElement tableElement)

Parameters

Returns

Gets the cell element for the specified row and column indices and view info.

Declaration

public VirtualGridCellElement GetCellElement(int rowIndex, int columnIndex, VirtualGridViewInfo viewInfo)

Parameters

Returns

Gets the scroll offset from the beginning of the columns in the specified view to the left edge of the specified column.

Declaration

public int GetColumnScrollOffset(int columnIndex, VirtualGridTableElement tableElement)

Parameters

Returns

Gets the scroll offset from the beginning of the columns in the specified view to the left edge of the specified column.

Declaration

public int GetColumnScrollOffset(int columnIndex, VirtualGridViewInfo viewInfo)

Parameters

Returns

Gets the height of the column at the given column index.

Declaration

public int GetColumnWidth(int columnIndex)

Parameters

Returns

Gets an editor based on a cell value. Used when column data types are not defined.

Declaration

protected virtual IInputEditor GetDefaultEditor(object value)

Parameters

Returns

Gets an editor based on the column data type.

Declaration

protected virtual IInputEditor GetEditor(Type dataType)

Parameters

Returns

Gets the row element for the specified row index and view info.

Declaration

public VirtualGridRowElement GetRowElement(int rowIndex, VirtualGridTableElement tableElement)

Parameters

Returns

Gets the row element for the specified row index and view info.

Declaration

public VirtualGridRowElement GetRowElement(int rowIndex, VirtualGridViewInfo viewInfo)

Parameters

Returns

Gets the height of the row at the given row index.

Declaration

public int GetRowHeight(int rowIndex)

Parameters

Returns

Gets the scroll offset from the beginning of the rows in the specified view to the top edge of the specified row.

Declaration

public int GetRowScrollOffset(int rowIndex, VirtualGridTableElement tableElement)

Parameters

Returns

Gets the scroll offset from the beginning of the rows in the specified view to the top edge of the specified row.

Declaration

public int GetRowScrollOffset(int rowIndex, VirtualGridViewInfo viewInfo)

Parameters

Returns

Gets the table element displaying the info of the specified view info..

Declaration

public VirtualGridTableElement GetTableElement(VirtualGridViewInfo viewInfo)

Parameters

Returns

Initializes the editor for editing. Allows settings of the editor to be modified. Fires the event.

Declaration

protected virtual void InitializeEditor(IInputEditor activeEditor, VirtualGridCellElement cell)

Parameters

Returns a value indicating whether the specified column is pinned.

Declaration

public bool IsColumnPinned(int columnIndex)

Parameters

Returns

Returns a value indicating whether the specified row is expanded.

Declaration

public bool IsRowExpanded(int rowIndex)

Parameters

Returns

Returns a value indicating whether the specified row is pinned.

Declaration

public bool IsRowPinned(int rowIndex)

Parameters

Returns

Moves the current cell to the one defined by the row and column indices.

Declaration

public bool MoveCurrent(int rowOffset, int columnOffset, bool keepSelection)

Parameters

Returns

Moves the current cell to the one below its current position.

Declaration

public bool MoveCurrentDown(bool keepSelection)

Parameters

Returns

Moves the current cell to the left of its current position.

Declaration

public bool MoveCurrentLeft(bool keepSelection)

Parameters