CardView.State Property
Obtains the View’s current state.
Namespace: DevExpress.XtraGrid.Views.Card
Assembly: DevExpress.XtraGrid.v23.2.dll
NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation
Declaration
Property Value
| Type | Description |
|---|---|
| CardState | A CardState 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 at present. |
| Sizing | A Card Separator is being dragged by the end-user at present. This action results in changing card width. |
| Editing | A cell editor is presently active. |
| CardUpButtonPressed | The top card scroll button is pressed. |
| CardDownButtonPressed | The bottom card scroll button is presently pressed. |
| CardExpandButtonPressed | The card’s expand button is pressed. |
| QuickCustomizeButtonPressed | The customization button is pressed. |
| CloseZoomButtonPressed | The Card View’s zoom button is pressed. |
| FilterPanelCloseButtonPressed | A filter close button is pressed. |
| FilterPanelActiveButtonPressed | A check box residing in a filter panel is pressed. This implies that the filter criteria applied to a Card View is going to be enabled or disabled. |
| Scrolling | A Card View is being scrolled. This means that an end-user has depressed the mouse wheel and moved the mouse to scroll the View’s contents. |
| FilterPanelTextPressed | The string in the filter panel which represents the filter criteria applied to a Card 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. |
Remarks
Use this property to determine which action is being performed by the end-user. Refer to the CardState enumeration description for a list of all available actions.
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.