Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

KeyEventHandler Delegate

Represents the method that will handle the UIElement.KeyUp and UIElement.KeyDown routed events, as well as related attached and Preview events.

Namespace:  System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)

public delegate void KeyEventHandler(
	Object sender,
	KeyEventArgs e
)

Parameters

sender
Type: System.Object

The object where the event handler is attached.

e
Type: System.Windows.Input.KeyEventArgs

The event data.

This delegate is used with the following attached events:

This delegate is also used with the following routed events on base elements. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF.

The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see Input Overview.

The following example checks whether the key associated with the event is the Return key.

private void OnKeyDownHandler(object sender, KeyEventArgs e)
{
    if (e.Key == Key.Return)
    {
        textBlock1.Text = "You Entered: " + textBox1.Text;
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft