KeyEventArgs Class

Definition

Namespace:

System.Windows.Input

Assembly:

PresentationCore.dll

Provides data for the KeyUp and KeyDown routed events, as well as related attached and Preview events.

public ref class KeyEventArgs : System::Windows::Input::KeyboardEventArgs

public class KeyEventArgs : System.Windows.Input.KeyboardEventArgs

type KeyEventArgs = class
    inherit KeyboardEventArgs

Public Class KeyEventArgs
Inherits KeyboardEventArgs

Inheritance

Object

EventArgs

RoutedEventArgs

InputEventArgs

KeyboardEventArgs

KeyEventArgs

Remarks

This event data class is used with the following attached events:

• Keyboard.KeyUp

• Keyboard.KeyDown

• Keyboard.PreviewKeyUp

• Keyboard.PreviewKeyDown

This event data class 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.

• UIElement.KeyUp

• UIElement.KeyDown

• UIElement.PreviewKeyUp

• UIElement.PreviewKeyDown

• ContentElement.KeyUp

• ContentElement.KeyDown

• ContentElement.PreviewKeyUp

• ContentElement.PreviewKeyDown

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.

A key can be in both the up and toggled states or the down and toggled states. For this reason, determining whether a key is up or down is not as simple as checking the KeyStates value as a numeric value. Instead, you should check the value by treating it as a flag enumeration. Use an AND comparison of the first bit. Alternatively, use the helper properties IsUp, IsDown, and IsToggled to determine whether a given key is up, down, or toggled.

Constructors

KeyEventArgs(KeyboardDevice, PresentationSource, Int32, Key)

Initializes a new instance of the KeyEventArgs class.

Properties

DeadCharProcessedKey	Gets the key that is part of dead key composition to create a single combined character.
Device	Gets the input device that initiated this event. (Inherited from InputEventArgs)
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)
ImeProcessedKey	Gets the keyboard key referenced by the event, if the key will be processed by an Input Method Editor (IME).
InputSource	Gets the input source that provided this input.
IsDown	Gets a value that indicates whether the key referenced by the event is in the down state.
IsRepeat	Gets a value that indicates whether the keyboard key referenced by the event is a repeated key.
IsToggled	Gets a value that indicates whether the key referenced by the event is in the toggled state.
IsUp	Gets a value that indicates whether the key referenced by the event is in the up state.
Key	Gets the keyboard key associated with the event.
KeyboardDevice	Gets the keyboard device associated with the input event. (Inherited from KeyboardEventArgs)
KeyStates	Gets the state of the keyboard key associated with this event.
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)
Source	Gets or sets a reference to the object that raised the event. (Inherited from RoutedEventArgs)
SystemKey	Gets the keyboard key referenced by the event, if the key will be processed by the system.
Timestamp	Gets the time when this event occurred. (Inherited from InputEventArgs)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InvokeEventHandler(Delegate, Object)	Invokes event handlers in a type-specific way, which can increase event system efficiency.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
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)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• KeyEventHandler
• KeyboardEventArgs
• KeyboardEventHandler