VGridOptionsBehavior.EditorShowMode Property
Gets or sets 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.XtraVerticalGrid
Assembly: DevExpress.XtraVerticalGrid.v24.1.dll
NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.VerticalGrid
Declaration
[DefaultValue(EditorShowMode.Default)]
[XtraSerializableProperty]
public virtual EditorShowMode EditorShowMode { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| EditorShowMode | Default | An EditorShowMode enumeration value that specifies how a cell editor is activated. |
Available values:
| 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. |
Property Paths
You can access this nested property as listed below:
| Object Type | Path to EditorShowMode |
|---|---|
| VGridControlBase |
|
Remarks
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.
Use the EditorShowMode option to specify how a cell editor is activated with the mouse:
- 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.
The cell content is selected in this mode. Disable the AutoSelectAllInEditor option to prevent content selection.
- MouseDownFocused — a cell editor is activated when the left mouse button is pressed in a focused cell.
- Click — a cell editor is activated when the left mouse button is pressed and released in a focused cell.
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.
In MouseDown and MouseDownFocused modes, the editor is activated when the mouse button is pressed and 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.
Note
If the Ctrl, Alt, or Shift key is pressed, the clicked cell is focused, but its editor is not activated.
See the following help topic for more information: Show and Hide Editors.