BandedGridView.State Property
Gets the View’s current state.
Namespace: DevExpress.XtraGrid.Views.BandedGrid
Assembly: DevExpress.XtraGrid.v23.2.dll
NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation
Declaration
Property Value
Type | Description |
---|---|
BandedGridState | A BandedGridState enumeration member indicating the View’s current state. |
Available values:
Name | Description |
---|---|
Normal | No specific action is being performed within a View. |
ColumnSizing | A column is being resized by the end-user. This implies that the column header’s right edge is being dragged. This operation is available only for columns whose OptionsColumn.AllowSize option is enabled. |
Editing | A cell editor is active at the moment. |
ColumnDragging | A column header is being dragged by the end-user. The column’s OptionsColumn.AllowMove and View’s GridOptionsCustomization.AllowColumnMoving options must be enabled to allow column header dragging. |
ColumnDown | A column header is pressed. |
ColumnFilterDown | A column’s filter button is pressed. |
GroupPanelFindPanelButtonPressed | The Find button in the group panel is pressed. |
RowDetailSizing | A detail View’s clone is being resized by the end-user. This implies that the detail’s bottom edge is being dragged. |
FilterCloseButtonPressed | A filter close button is pressed. |
ColumnButtonDown | A header panel button is pressed. |
RowSizing | A data row is being resized by the end-user. This implies that the corresponding indicator cell’s bottom edge is being dragged. The GridOptionsCustomization.AllowRowSizing option must be enabled to allow such operations. |
IncrementalSearch | The incremental search is being performed. |
Selection | Multiple rows are being selected using the dragging operation. This implies that the end-user presses an indicator cell corresponding to the selection start and drags the mouse to the selection end. The ColumnViewOptionsSelection.MultiSelect option must be enabled to make this operation available. |
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 using the 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 has depressed the mouse wheel and is moving the mouse to scroll the View’s contents. |
ColumnHeaderSearchButtonDown | The search button in a column header is pressed. |
GroupPanelColumnHeaderSearchButtonDown | The search button in a grouped column header is pressed. |
HeaderSearchEditing | The user types within the column header (in column header search). See InHeaderSearchMode. |
ColumnHeaderSearchTextDown | The search text in a column header is pressed. |
GroupPanelColumnHeaderSearchTextDown | The search text in a grouped column header is pressed. |
Unknown | An unknown action is being performed within a View. |
BandSizing | A band is being resized by the end-user. This implies that the band header’s right edge is being dragged. This operation is available only for bands whose OptionsBand.AllowSize option is enabled. |
BandDragging | A band header is being dragged by the end-user. The band’s OptionsBand.AllowMove option must be enabled to allow band header dragging. |
BandDown | A band header is pressed. |
Remarks
Use this property to determine which action is being performed by the end-user. Refer to the BandedGridStateenumeration 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 while the user is performing a dragging operation.