BandedGridView.State Property

Gets the View’s current state.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

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

VB.NET

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

Property Value

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

Available values:

Show 22 items

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.
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.
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.

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#

how-to-create-a-advbandedgridview-descendant-class-and-register-it-for-design-time-use-t122322/CS/MyAdvBandedGridView/MyAdvBandedGridViewHandler.cs#L22

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

how-to-create-a-bandedgridview-descendant-class-and-register-it-for-design-time-use-t122275/CS/MyBandedGridView/MyBandedGridViewHandler.cs#L21

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

advbandedgridview-how-to-disable-restoring-bands-from-customization-form-via-double-click-t228408/CS/MyAdvBandedGridView/MyAdvBandedGridViewHandler.cs#L36

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

VB.NET

how-to-create-a-advbandedgridview-descendant-class-and-register-it-for-design-time-use-t122322/VB/MyAdvBandedGridView/MyAdvBandedGridViewHandler.vb#L20

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

how-to-create-a-bandedgridview-descendant-class-and-register-it-for-design-time-use-t122275/VB/MyBandedGridView/MyBandedGridViewHandler.vb#L19

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

advbandedgridview-how-to-disable-restoring-bands-from-customization-form-via-double-click-t228408/VB/MyAdvBandedGridView/MyAdvBandedGridViewHandler.vb#L34

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