VGridControlBase.State Property

Indicates the vertical grid’s current state.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v19.2.dll

Declaration

C#

[Browsable(false)]
public VGridState State { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property State As VGridState

Property Value

Type	Description
VGridState	A VGridState enumeration value that indicates the vertical grid’s current state.

Available values:

Name	Description
Regular	The control is in its normal state. No specific action is being performed by the end-user.
Editing	A cell editor is currently active.
FocusedRowChanging	The focused row has changed.
RowDragging	A row’s header is being dragged. The desired row’s VGridOptionsRow.AllowMove and the control’s VGridOptionsBehavior.DragRowHeaders options must both be enabled to allow row header dragging. Note that the user can drag row headers regardless of these options’ states if the Customization Form is shown.
RowSizing	A row header’s bottom edge is being dragged to change row height. The desired row’s VGridOptionsRow.AllowSize and control’s VGridOptionsBehavior.ResizeRowHeaders options must both be enabled to allow such resizing operations.
MultiEditorRowCellSizing	A multi-editor row cell’s separator is being dragged by the end-user. This action results in changing cell width.
HeaderPanelSizing	A row header panel’s right edge is being dragged to change the row header’s width. The width of the row header panel can also be changed using the CTRL-LEFT and CTRL-RIGHT key combinations. The control’s VGridOptionsBehavior.ResizeHeaderPanel option must be enabled to allow such resizing.
RecordSizing	A record’s right edge is being dragged to change record width. The control’s VGridOptionsBehavior.ResizeRowValues option must be enabled to allow such resizing.
Disposed	A vertical grid is being disposed of.

Remarks

Use the State property to determine which action is being performed by an end-user.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the State property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-move-focus-from-the-last-row-to-the-first-row-when-the-tab-key-is-pressed-e897/CS/Form1.cs#L160

if(e.KeyData == Keys.Tab && grid.FocusedRow == grid.GetLastVisible()) {
    bool needShowEditor = (grid.State == VGridState.Editing);
    grid.FocusedRow = grid.Rows.FirstVisible;

VB.NET

how-to-move-focus-from-the-last-row-to-the-first-row-when-the-tab-key-is-pressed-e897/VB/Form1.vb#L151

If e.KeyData = Keys.Tab AndAlso grid.FocusedRow Is grid.GetLastVisible() Then
    Dim needShowEditor As Boolean = (grid.State = VGridState.Editing)
    grid.FocusedRow = grid.Rows.FirstVisible