GridView.HideEditor() Method

Hides the active editor discarding any changes made.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public override void HideEditor()

VB.NET

Public Overrides Sub HideEditor

Remarks

The HideEditor method destroys the edited cell’s editor and switches the View to browse mode. Changes made within the edited cell are discarded. The HideEditor method is automatically called when an end-user presses the ESC key after modifying the cell’s value. Note that calling this method raises the ColumnView.HiddenEditor event.

If no cell is being edited at the present moment, calling the HideEditor method does nothing.

Please refer to the Modify and Validate Cell Values topic for additional information.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the HideEditor member must not be invoked for these Views. The HideEditor 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 snippets (auto-collected from DevExpress Examples) contain references to the HideEditor() method.

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-gridview-descendant-displaying-images-against-text-in-cells-e1997/CS/ImageTextEdit/CustomGridControl/CustomGridView/CustomGridView.cs#L64

    }
    base.HideEditor();
}

how-to-create-a-multi-line-editor-that-draws-an-image-in-its-left-side-e4963/CS/ImageMemoEdit/CustomGridControl/CustomGridView/CustomGridView.cs#L68

    }
    base.HideEditor();
}

VB.NET

how-to-create-a-gridview-descendant-displaying-images-against-text-in-cells-e1997/VB/ImageTextEdit/CustomGridControl/CustomGridView/CustomGridView.vb#L80

    End If
    MyBase.HideEditor()
End Sub

how-to-create-a-multi-line-editor-that-draws-an-image-in-its-left-side-e4963/VB/ImageMemoEdit/CustomGridControl/CustomGridView/CustomGridView.vb#L84

    End If
    MyBase.HideEditor()
End Sub