BaseView.CloseEditor() Method

Hides the active editor saving changes made.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public void CloseEditor()

VB.NET

Public Sub CloseEditor

Remarks

Cell values are edited by editors from the DevExpress Editors Library or their descendants. Unlike the BaseView.HideEditor method which simply closes the active editor, the CloseEditor method also saves the changes made to the edited cell’s content. This method can be useful, for instance, when you need to close the text editor and to save its contents when the input string length reaches a predefined value.

The CloseEditor method is also called automatically when the end-user accepts the edited value.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the CloseEditor member must not be invoked for these Views. The CloseEditor 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 CloseEditor() 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-temporary-disable-grid-cell-editors-buttons-e565/CS/Form1.cs#L37

DataRow dr = view.GetDataRow(view.FocusedRowHandle);
view.CloseEditor();
view.UpdateCurrentRow();

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/CS/E4669CS/CustomFieldFilterControl.cs#L163

{
    gridView1.CloseEditor();
}

how-to-add-a-new-row-to-a-grid-by-typing-in-a-new-item-row-as-in-datagridview-e2891/CS/WindowsApplication3/Main.cs#L37

{
    gridView.CloseEditor();
    gridView.UpdateCurrentRow();

how-to-make-sure-that-all-modifications-are-saved-in-xtragrid-e3303/CS/GridViewSaveChangesExample/Form1.cs#L19

ColumnView view = (ColumnView)gridControl1.FocusedView;
view.CloseEditor();
if (view.UpdateCurrentRow())

how-to-save-the-value-of-an-in-place-check-box-as-soon-as-it-is-changed-e862/CS/Form1.cs#L29

// Save data to a persistent storage
gridView1.CloseEditor();
gridView1.UpdateCurrentRow();

VB.NET

how-to-temporary-disable-grid-cell-editors-buttons-e565/VB/Form1.vb#L35

Dim dr As DataRow = view.GetDataRow(view.FocusedRowHandle)
view.CloseEditor()
view.UpdateCurrentRow()

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/VB/CustomFieldFilterControl.vb#L159

Private Sub repositoryItemCheckEdit1_CheckedChanged(ByVal sender As Object, ByVal e As EventArgs) Handles repositoryItemCheckEdit1.CheckedChanged
    gridView1.CloseEditor()
End Sub

how-to-add-a-new-row-to-a-grid-by-typing-in-a-new-item-row-as-in-datagridview-e2891/VB/WindowsApplication3/Main.vb#L31

If gridView.FocusedRowHandle = GridControl.NewItemRowHandle Then
    gridView.CloseEditor()
    gridView.UpdateCurrentRow()

how-to-make-sure-that-all-modifications-are-saved-in-xtragrid-e3303/VB/GridViewSaveChangesExample/Form1.vb#L21

Dim view As ColumnView = CType(gridControl1.FocusedView, ColumnView)
view.CloseEditor()
If view.UpdateCurrentRow() Then

how-to-save-the-value-of-an-in-place-check-box-as-soon-as-it-is-changed-e862/VB/Form1.vb#L31

' Save data to a persistent storage
gridView1.CloseEditor()
gridView1.UpdateCurrentRow()