GridView.State Property

Gets the View’s current state.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

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

VB.NET

<Browsable(False)>
Public Overridable ReadOnly Property State As GridState

Property Value

Type	Description
GridState	A GridState enumeration member indicating the View’s current state

Available values:

Show 19 items

Name	Description
Normal	The View is in its normal state. No specific action is being performed by the end-user.
ColumnSizing	A column’s right edge is being dragged to change the column’s width. The desired column’s OptionsColumn.AllowSize option must be enabled to allow such resizing.
Editing	A cell editor is presently active.
ColumnDragging	A column header is being dragged. The desired column’s OptionsColumn.AllowMove and View’s GridOptionsCustomization.AllowColumnMoving options must be enabled to allow column header dragging (the default behavior).
ColumnDown	A column header is presently pressed.
ColumnFilterDown	A filter button is presently pressed.
RowDetailSizing	A detail clone View’s bottom edge is being dragged to resize the View vertically.
FilterPanelCloseButtonPressed	A filter close button is pressed.
ColumnButtonDown	The header panel button is presently pressed.
RowSizing	A data row’s bottom edge is being dragged to change row height. The View’s GridOptionsCustomization.AllowRowSizing option must be enabled to allow such resizing operations.
IncrementalSearch	Incremental search is being performed.
Selection	Multiple rows are being selected using drag and drop. End-users must click an indicator cell and drag the mouse for this purpose. The ColumnViewOptionsSelection.MultiSelect option must be enabled to allow such selections.
FilterPanelActiveButtonPressed	A check box residing in a filter panel is pressed. This implies that the filter criteria applied to a View is going to be enabled or disabled.
FilterPanelTextPressed	The string in the filter panel which represents the filter criteria applied to a View is pressed. This shows/hides a dropdown window with a list of the most recently used filter criteria.
FilterPanelMRUButtonPressed	The button which is used to display a dropdown window with a list of the most recently used filter criteria is pressed.
FilterPanelCustomizeButtonPressed	A filter panel customize button is pressed.
CellSelection	Multiple cells are being selected by an end-user via a mouse. The GridOptionsSelection.MultiSelectMode property must be set to the GridMultiSelectMode.CellSelect value to make this operation available.
Scrolling	A View is being scrolled. This implies that an end-user depresses the mouse wheel and moves the mouse to scroll the View’s contents.
Unknown	An unknown action is being performed within the Grid View.

Remarks

Use this property to determine which action is being performed by the end-user. Refer to the GridState enumeration description for a list of all available states.

An example of using the State property can include suspension of a given operation until the end-user completes an action against the grid control. For instance, you may need to display a notification message and suspend it if the user is performing a dragging operation at a given moment in time.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the State member must not be invoked for these Views. The State member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

xtragrid-how-to-automatically-put-search-text-in-quotation-marks-in-filter-panel-e5086/CS/MyXtraGrid/MyGridHandler.cs#L16

base.OnKeyDown(e);
if (e.KeyData == Keys.Delete && View.State == GridState.Normal)
{

how-to-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/CS/CustomDescendants/TreeListForBands.cs#L138

    bool IsDragging { get { return View != null && (View as GridView).State == GridState.ColumnDragging; } }
}

how-to-introduce-the-ability-to-drag-columns-between-grids-e2197/CS/MyGridHandler.cs#L17

base.OnKeyDown(e);
if(e.KeyData == Keys.Delete && View.State == GridState.Normal)
    View.DeleteRow(View.FocusedRowHandle);

how-to-show-a-confirmation-dialog-before-sorting-a-column-e555/CS/AskForSorting/Form1.cs#L24

GridView view = sender as GridView;
if(view.State != GridState.ColumnDown) return;

how-to-show-a-tooltip-during-resizing-a-grid-column-in-the-manner-used-in-excel-e2697/CS/WindowsApplication3/Form1.cs#L30

GridPainter painter = viewInfo.Painter;
if (view.State == GridState.ColumnSizing)
{

VB.NET

xtragrid-how-to-automatically-put-search-text-in-quotation-marks-in-filter-panel-e5086/VB/MyXtraGrid/MyGridHandler.vb#L15

MyBase.OnKeyDown(e)
If e.KeyData = Keys.Delete AndAlso View.State = GridState.Normal Then
    View.DeleteRow(View.FocusedRowHandle)

how-to-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/VB/CustomDescendants/TreeListForBands.vb#L145

Get
    Return View IsNot Nothing AndAlso (TryCast(View, GridView)).State = GridState.ColumnDragging
End Get

how-to-introduce-the-ability-to-drag-columns-between-grids-e2197/VB/MyGridHandler.vb#L21

MyBase.OnKeyDown(e)
If e.KeyData = Keys.Delete AndAlso View.State = GridState.Normal Then
    View.DeleteRow(View.FocusedRowHandle)

how-to-show-a-confirmation-dialog-before-sorting-a-column-e555/VB/Form1.vb#L25

Dim view As GridView = TryCast(sender, GridView)
If view.State <> GridState.ColumnDown Then Return

how-to-show-a-tooltip-during-resizing-a-grid-column-in-the-manner-used-in-excel-e2697/VB/WindowsApplication3/Form1.vb#L37

Dim painter As GridPainter = viewInfo.Painter
If view.State = GridState.ColumnSizing Then
    Dim col As GridColumn = TryCast(painter.ReSizingObject, GridColumn)