Skip to main content

DataViewBase.GetActiveEditorNeedsKey Event

Allows you to specify whether an active editor responds to keys that an end user presses.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v22.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core


public event EventHandler<GetActiveEditorNeedsKeyEventArgs> GetActiveEditorNeedsKey

Event Data

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

Property Description
Column Gets or sets a grid column, for which an event has been raised. Inherited from EditorEventArgsBase.
Handled Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
Key Gets a key an end-user presses.
Modifiers Gets a value indicating which of the modifier keys (Shift, Ctrl, and Alt) is in a pressed state.
NeedsKey Gets or sets whether an active editor responds to a key an end user presses.
OriginalSource Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
RowHandle Gets or sets the row handle, for which an event has been raised. Inherited from EditorEventArgsBase.
Source Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
TemplateChild An in-place editor specified in a cell template.
Value Gets the edit value stored in the editor, for which an event has been raised. Inherited from EditorEventArgsBase.

The event data class exposes the following methods:

Method Description
InvokeEventHandler(Delegate, Object) When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object) When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.



The following code sample shows how to make an editor respond to the Up and Down keys:

View Example: How to Specify Navigation in Custom Cell Editors

<dxg:GridControl ItemsSource="{Binding Items}">
    <dxg:GridColumn FieldName="Country"/>
    <dxg:GridColumn FieldName="City">
                <dxe:ListBoxEdit x:Name="PART_Editor" ItemsSource="{Binding RowData.Row.Cities}" />
        <dxg:TableView GetActiveEditorNeedsKey="GetActiveEditorNeedsKey" />
private void GetActiveEditorNeedsKey(object sender, DevExpress.Xpf.Grid.GetActiveEditorNeedsKeyEventArgs e) {
    if (e.Column.FieldName == "City" && (e.Key == System.Windows.Input.Key.Up || e.Key == System.Windows.Input.Key.Down))
        e.NeedsKey = true;

Process End User Actions

The GridControl provides the following events to process end user actions:

Event Description
DataViewBase.GetIsEditorActivationAction Allows you to specify whether an action (key down, text input, or mouse left button click) activates the focused editor.
DataViewBase.ProcessEditorActivationAction Allows you to make the focused editor process an activation action.
DataViewBase.GetActiveEditorNeedsKey Allows you to specify whether an active editor responds to keys that end user presses.

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


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.

See Also