EditorShowMode Enum

Enumerates values that specify whether a cell editor is activated when the left mouse button is pressed or released, and whether the cell should be focused to activate the editor.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.2.dll

Declaration

C#

public enum EditorShowMode

VB.NET

Public Enum EditorShowMode

Members

Name	Description
Default	The mode is not specified explicitly. The actual mode depends on the control and its settings. See remarks in the following topic for more information: EditorShowMode Enum.
MouseDown	A cell editor is activated when the left mouse button is pressed regardless of whether the cell is focused.
MouseUp	A cell editor is activated when the left mouse button is pressed and released in the same cell regardless of whether the cell is focused.
Click	A cell editor is activated when the left mouse button is pressed and released in a focused cell.
MouseDownFocused	A cell editor is activated when the left mouse button is pressed in a focused cell.

Related API Members

The following properties accept/return EditorShowMode values:

• BarEditItem.EditorShowMode
• ColumnViewOptionsBehavior.EditorShowMode
• PivotGridOptionsBehavior.EditorShowMode
• VGridOptionsBehavior.EditorShowMode

Remarks

Use the EditorShowMode enumeration to specify how a cell editor is activated with the mouse. An editor can be activated when the left mouse button is pressed or released, and may depend on whether the cell is already focused.

When the left mouse button is pressed in a cell for the first time, the cell gets focus. Then the mouse button is released. After the cell is focused, a user can press and release the button again. You can activate a cell editor at each of these four stages depending on usability requirements.

For example, if a control should support drag-and-drop operations, activate an editor when the mouse button is released, not when it is pressed. On the other hand, if an editor’s drop-down window should be opened at the same time a cell is focused, activate the editor when the mouse button is pressed, not when it is released.

Default Mode

The Default value does not specify the mode explicitly. The actual mode depends on the control and its settings.

Data Grid

In the Data Grid, the Default value is equivalent to the MouseDown value except for the following cases:

• Users can select multiple cells. That is, the MultiSelectMode option is set to CellSelect. In this case, the Default value is equivalent to the Click value.

• Users can select multiple rows in the built-in check column. That is, the MultiSelectMode option is set to CheckBoxRowSelect. In this case, the Default value is equivalent to the MouseUp value.

Vertical Grid

In the Vertical Grid, the Default value is equivalent to the MouseDown value except if users can select multiple cells. That is, the MultiSelectMode option is set to CellSelect. In this case, the Default value is equivalent to the Click value.

Pivot Grid

In the Pivot Grid, the Default value is equivalent to the MouseDownFocused value.

Tree List

In the Tree List, use the EditorShowMode option to specify how a cell editor is activated.

Mouse Events

In MouseDown and MouseDownFocused modes, the editor is activated when the mouse button is pressed and then this mouse event is passed to the activated editor. For example, in an ImageComboBoxEdit, this causes the drop-down window to open. On the other hand, the user cannot drag the row.

In MouseUp and Click modes, the editor is not activated when the mouse button is pressed. This results in this mouse event not being passed to the editor. For example, in an ImageComboBoxEdit, this causes the drop-down window to not open. The user should click the editor one more time to open the drop-down window. On the other hand, the user can drag the row.