GridView.IsEditing Property

Indicates whether a cell editor is active presently.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[Browsable(false)]
public override bool IsEditing { get; }

VB.NET

<Browsable(False)>
Public Overrides ReadOnly Property IsEditing As Boolean

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.

C#

using DevExpress.XtraGrid.Views.Base;

ColumnView view = gridControl1.FocusedView as ColumnView;
string editingValue = null;
if (view != null && view.IsEditing)
    editingValue = view.EditingValue.ToString();

VB.NET

Imports DevExpress.XtraGrid.Views.Base

Dim view As ColumnView = CType(GridControl1.FocusedView, ColumnView)
Dim editingValue As String = Nothing
If view IsNot Nothing And view.IsEditing Then
    editingValue = view.EditingValue.ToString()
End If

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.

C#

how-to-display-a-check-box-to-indicate-a-value-presence-in-another-grid-columns-cell-e522/CS/EditorStatusViaCustomDraw/Form1.cs#L28

GridView grid = sender as GridView;
if(grid.IsEditing && e.RowHandle == grid.FocusedRowHandle && grid.FocusedColumn.FieldName == "Column1") {
    text = grid.ActiveEditor.Text;

how-to-implement-hot-tracking-for-grid-rows-e724/CS/E724/CS/ViewHotTrackHelper.cs#L76

void TargetView_MouseMove(object sender, System.Windows.Forms.MouseEventArgs e) {
    if (targetView.IsEditing) return;
    var hitInfo = targetView.CalcHitInfo(e.X, e.Y);

how-to-prevent-the-rowcellstyle-event-from-overriding-the-format-conditions-appearance-e1998/CS/GridView_PriorityRowCellStyle/CustomGridControl.cs#L122

if (cell.IsDataCell)
    if ((cell.State & GridRowCellState.FocusedCell) == 0 || !View.IsEditing)
    {

VB.NET

how-to-display-a-check-box-to-indicate-a-value-presence-in-another-grid-columns-cell-e522/VB/EditorStatusViaCustomDraw/Form1.vb#L30

Dim grid As GridView = TryCast(sender, GridView)
If grid.IsEditing AndAlso e.RowHandle = grid.FocusedRowHandle AndAlso grid.FocusedColumn.FieldName = "Column1" Then
    text = grid.ActiveEditor.Text

how-to-implement-hot-tracking-for-grid-rows-e724/VB/E724/CS/ViewHotTrackHelper.vb#L96

Private Sub TargetView_MouseMove(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs)
    If targetView.IsEditing Then
        Return

how-to-prevent-the-rowcellstyle-event-from-overriding-the-format-conditions-appearance-e1998/VB/GridView_PriorityRowCellStyle/CustomGridControl.vb#L164

If cell.IsDataCell Then
    If (cell.State And GridRowCellState.FocusedCell) = 0 OrElse (Not View.IsEditing) Then
        Dim condition As AppearanceObjectEx = Nothing