LayoutView.State Property

Obtains the View’s current state.

Namespace: DevExpress.XtraGrid.Views.Layout

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Description
DevExpress.XtraGrid.Views.Layout.LayoutViewState	A DevExpress.XtraGrid.Views.Layout.LayoutViewState enumeration member indicating the View’s current state.

Remarks

Use the State property to determine which action is currently being performed by an end-user.

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 snippet (auto-collected from DevExpress Examples) contains a reference 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-layoutview-descendant-class-and-register-it-for-design-time-use-t122335/CS/MyLayoutView/MyLayoutHandler.cs#L22

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

VB.NET

how-to-create-a-layoutview-descendant-class-and-register-it-for-design-time-use-t122335/VB/MyLayoutView/MyLayoutHandler.vb#L20

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