EditorContainer.EditorKeyDown Event

Occurs when a key is pressed within an in-place editor that belongs to the container control.

Namespace: DevExpress.XtraEditors.Container

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("ContainerEvents")]
public event KeyEventHandler EditorKeyDown

VB.NET

<DXCategory("ContainerEvents")>
Public Event EditorKeyDown As KeyEventHandler

Event Data

The EditorKeyDown event's data class is KeyEventArgs. The following properties provide information specific to this event:

Property	Description
Alt	Gets a value indicating whether the ALT key was pressed.
Control	Gets a value indicating whether the CTRL key was pressed.
Handled	Gets or sets a value indicating whether the event was handled.
KeyCode	Gets the keyboard code for a KeyDown or KeyUp event.
KeyData	Gets the key data for a KeyDown or KeyUp event.
KeyValue	Gets the keyboard value for a KeyDown or KeyUp event.
Modifiers	Gets the modifier flags for a KeyDown or KeyUp event. The flags indicate which combination of CTRL, SHIFT, and ALT keys was pressed.
Shift	Gets a value indicating whether the SHIFT key was pressed.
SuppressKeyPress	Gets or sets a value indicating whether the key event should be passed on to the underlying control.

Remarks

The EditorKeyDown event occurs when a key is pressed within an active in-place editor that belongs to the container control. If you continue to depresss the key, the event will be triggered repeatedly with a short interval.

The EditorKeyDown event is fired for any key pressed. If you need only alpha-numeric characters to be processed, you can handle the EditorContainer.EditorKeyPress event instead. This event occurs only for alpha-numeric characters right after the EditorKeyDown event is generated.

After the key is released, the EditorContainer.EditorKeyUp event is fired.

Key press events are fired in the following order:

• EditorKeyDown
• EditorContainer.EditorKeyPress (only for alpha-numeric keys)
• EditorContainer.EditorKeyUp

Related GitHub Examples

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

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-change-the-default-navigation-algorithm-in-gridview-e3185/CS/Form1.cs#L44

_View = view;
view.GridControl.EditorKeyDown += GridControl_EditorKeyDown;
view.GridControl.KeyDown += GridControl_EditorKeyDown;

how-to-append-a-new-row-when-pressing-enter-or-tab-in-the-last-cell-e3810/CS/Form1.cs#L51

_View.HiddenEditor += _View_HiddenEditor;
view.GridControl.EditorKeyDown += GridControl_EditorKeyDown;
view.GridControl.KeyDown += new KeyEventHandler(GridControl_KeyDown);

VB.NET

how-to-change-the-default-navigation-algorithm-in-gridview-e3185/VB/Form1.vb#L41

_View = view
AddHandler view.GridControl.EditorKeyDown, AddressOf GridControl_EditorKeyDown
AddHandler view.GridControl.KeyDown, AddressOf GridControl_EditorKeyDown

how-to-implement-the-cells-multi-selection-feature-in-treelist-e2795/VB/WindowsApplication1/Helper/BlockSelector.vb#L37

    AddHandler fList.PopupMenuShowing, AddressOf fList_PopupMenuShowing
    AddHandler fList.EditorKeyDown, AddressOf fList_EditorKeyDown
End Sub

how-to-append-a-new-row-when-pressing-enter-or-tab-in-the-last-cell-e3810/VB/Form1.vb#L38

_View = view
AddHandler view.GridControl.EditorKeyDown, AddressOf GridControl_EditorKeyDown
AddHandler view.GridControl.KeyDown, AddressOf GridControl_KeyDown