Back to Devexpress

EditorContainer.EditorKeyDown Event

windowsforms-devexpress-dot-xtraeditors-dot-container-dot-editorcontainer-b3b0adbf.md

latest6.6 KB
Original Source

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.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DXCategory("ContainerEvents")]
public event KeyEventHandler EditorKeyDown
vb
<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:

PropertyDescription
AltGets a value indicating whether the ALT key was pressed.
ControlGets a value indicating whether the CTRL key was pressed.
HandledGets or sets a value indicating whether the event was handled.
KeyCodeGets the keyboard code for a KeyDown or KeyUp event.
KeyDataGets the key data for a KeyDown or KeyUp event.
KeyValueGets the keyboard value for a KeyDown or KeyUp event.
ModifiersGets the modifier flags for a KeyDown or KeyUp event. The flags indicate which combination of CTRL, SHIFT, and ALT keys was pressed.
ShiftGets a value indicating whether the SHIFT key was pressed.
SuppressKeyPressGets 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:

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

winforms-grid-auto-add-new-row-after-editing-last-cell/CS/Form1.cs#L51

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

winforms-grid-auto-add-new-row-after-editing-last-cell/VB/Form1.vb#L48

vb
AddHandler _View.HiddenEditor, AddressOf _View_HiddenEditor
AddHandler view.GridControl.EditorKeyDown, AddressOf GridControl_EditorKeyDown
AddHandler view.GridControl.KeyDown, New KeyEventHandler(AddressOf GridControl_KeyDown)

See Also

EditorContainer Class

EditorContainer Members

DevExpress.XtraEditors.Container Namespace