GridView.State Property
Gets the View’s current state.
Namespace: DevExpress.XtraGrid.Views.Grid
Assembly: DevExpress.XtraGrid.v22.2.dll
NuGet Package: DevExpress.Win.Grid
Declaration
Property Value
| Type | Description |
|---|---|
| GridState | A GridState enumeration member indicating the View’s current state |
Available values:
| 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. |
| GroupPanelFindPanelButtonPressed | The Find panel’s Find button is 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. |
| ColumnHeaderSearchButtonDown | A column header search button is pressed. |
| GroupPanelColumnHeaderSearchButtonDown | The Search button displayed within the group panel is pressed. |
| HeaderSearchEditing | The user types within the column header (in column header search). |
| ColumnHeaderSearchTextDown | Reserved for future use. |
| GroupPanelColumnHeaderSearchTextDown | Reserved for future use. |
| 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 Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.
- 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.