GridView.IsEditing Property
Indicates whether a cell editor is active presently.
Namespace: DevExpress.XtraGrid.Views.Grid
Assembly: DevExpress.XtraGrid.v19.2.dll
Declaration
Property Value
Type | Description |
---|---|
Boolean | true if the View is in the edit mode; otherwise, false. |
Remarks
This property returns true if the GridView.State property value is GridState.Editing. Otherwise, false is returned. Note that you can also compare the View’s ColumnView.ActiveEditor property value to null (Nothing in Visual Basic) to determine whether a cell editor is currently active.
If the IsEditing property returns true, you can access the current edited value using the GridView.EditingValue property.
Note
Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the IsEditing member must not be invoked for these Views. The IsEditing 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.
Example
The following code shows how you can obtain the text representation of the currently edited cell value.
using DevExpress.XtraGrid.Views.Base;
ColumnView view = gridControl1.FocusedView as ColumnView;
string editingValue = null;
if (view != null && view.IsEditing)
editingValue = view.EditingValue.ToString();
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the IsEditing 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.