EditorShowMode Enum

Contains values that specify how an in-place editor is activated for a cell in a container control.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v18.1.dll

Declaration

C#

public enum EditorShowMode

VB.NET

Public Enum EditorShowMode

Members

Name	Description
Default	Specifies the default behavior. For the Grid Control, the Default value is equivalent to: - EditorShowMode.Click - in multiple cell selection mode (see GridMultiSelectMode.CellSelect) - EditorShowMode.MouseUp - in multiple row selection mode if the built-in Check column is enabled (see GridMultiSelectMode.CheckBoxRowSelect) - EditorShowMode.MouseDown - in other cases. For the PivotGrid control, this option acts as the EditorShowMode.MouseDownFocused option.
MouseDown	A cell’s in-place editor is activated when the left mouse button is pressed.
MouseUp	A cell’s in-place editor is activated when a mouse button is released from a click within the cell.
Click	If a cell is focused and not being edited, an in-place editor is opened on a click (the mouse button is pressed and then released). Clicking a non-focused cell focuses the cell first, and a subsequent click activates the in-place editor (if not prohibited).
MouseDownFocused	If a cell is focused and not being edited, an in-place editor is opened on pressing the mouse button. Clicking a non-focused cell focuses the cell first, and a subsequent mouse-down event activates the in-place editor (if not prohibited).

Related API Members

The following properties accept/return EditorShowMode values:

• BarEditItem.EditorShowMode
• ColumnViewOptionsBehavior.EditorShowMode
• PivotGridOptionsBehavior.EditorShowMode
• TileViewOptionsBehavior.EditorShowMode
• WinExplorerViewOptionsBehavior.EditorShowMode

Remarks

In-place editors within container controls can be invoked when a mouse button is pressed, released or on a subsequent mouse click. A control that supports these modes provides a property of the EditorShowMode class (for instance, ColumnViewOptionsBehavior.EditorShowMode in the XtraGrid).

Choosing an in-place editor activation mode depends on usability requirements and any additional functionality that should be implemented. For instance, if drag and drop of rows must be supported in a container control you can choose the EditorShowMode.MouseUp or EditorShowMode.Click mode to open editors (in the EditorShowMode.MouseDown mode a drag and drop operation cannot be initiated because an in-place editor is activated once a cell is clicked).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EditorShowMode enum.

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#

custom-gridcontrol-how-to-create-columns-with-the-editorshowmode-property-e4356/CS/GridProject/ExtendedGridView/ExtendedGridColumn.cs#L15

{
    EditorShowMode = DevExpress.Utils.EditorShowMode.Default;
}

gridview-how-to-select-multiple-rows-by-dragging-the-mouse-in-rowselect-mode-t495772/CS/DXApplication3/CustomGrid.cs#L67

}
public override EditorShowMode GetShowEditorMode()
{

how-to-handle-a-double-click-on-a-grid-row-or-cell-e595/CS/DoubleClickCell/Form1.cs#L47

gridView1.OptionsBehavior.Editable = true;
gridView1.OptionsBehavior.EditorShowMode = DevExpress.Utils.EditorShowMode.Click;
gridView1.DoubleClick += gridView1_DoubleClick;

XAF_how-to-add-an-unbound-column-to-gridlisteditor-to-execute-a-custom-action-for-a-record-e1748/CS/WinSolution.Module.Win/SimpleBusinessActionGridListViewController.cs#L37

    gridListEditor.GridView.CustomRowCellEditForEditing += gridView_CustomRowCellEdit;
    gridListEditor.GridView.OptionsBehavior.EditorShowMode = EditorShowMode.MouseDown;
}

drag-and-drop-of-multiple-selected-grid-rows-e752/CS/Form1.cs#L164

gridView1.OptionsSelection.MultiSelect = true;
gridView1.OptionsBehavior.EditorShowMode = DevExpress.Utils.EditorShowMode.MouseUp;

VB.NET

custom-gridcontrol-how-to-create-columns-with-the-editorshowmode-property-e4356/VB/GridProject/ExtendedGridView/ExtendedGridColumn.vb#L14

Public Sub New()
    EditorShowMode = DevExpress.Utils.EditorShowMode.Default
End Sub

gridview-how-to-select-multiple-rows-by-dragging-the-mouse-in-rowselect-mode-t495772/VB/DXApplication3/CustomGrid.vb#L63

End Sub
Public Overrides Function GetShowEditorMode() As EditorShowMode
    If OptionsBehavior.EditorShowMode = EditorShowMode.Default AndAlso IsRowSelect Then

how-to-handle-a-double-click-on-a-grid-row-or-cell-e595/VB/DoubleClickCell/Form1.vb#L53

gridView1.OptionsBehavior.Editable = True
gridView1.OptionsBehavior.EditorShowMode = DevExpress.Utils.EditorShowMode.Click
AddHandler gridView1.DoubleClick, AddressOf gridView1_DoubleClick

XAF_how-to-add-an-unbound-column-to-gridlisteditor-to-execute-a-custom-action-for-a-record-e1748/VB/WinSolution.Module.Win/SimpleBusinessActionGridListViewController.vb#L39

    AddHandler gridListEditor.GridView.CustomRowCellEditForEditing, AddressOf gridView_CustomRowCellEdit
    gridListEditor.GridView.OptionsBehavior.EditorShowMode = EditorShowMode.MouseDown
End Sub

drag-and-drop-of-multiple-selected-grid-rows-e752/VB/Form1.vb#L163

gridView1.OptionsSelection.MultiSelect = True
gridView1.OptionsBehavior.EditorShowMode = DevExpress.Utils.EditorShowMode.MouseUp