KeyEventArgs Class

July 28, 2014

Provides event data for the UIElement.KeyUp and UIElement.KeyDown events.

System.Object
  System.EventArgs
    System.Windows.RoutedEventArgs
      System.Windows.Input.KeyEventArgs

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

public sealed class KeyEventArgs : RoutedEventArgs

The KeyEventArgs type exposes the following members.

  NameDescription
Public propertyHandledGets or sets a value that marks the routed event as handled. A true value for Handled prevents most handlers along the event route from handling the same event again.
Public propertyKeyGets the keyboard key associated with the event.
Public propertyOriginalSourceGets a reference to the object that raised the event. (Inherited from RoutedEventArgs.)
Public propertyPlatformKeyCodeGets an integer value that represents the key that is pressed or released (depending on which event is raised). This value is the nonportable key code, which is operating system–specific.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Key events can be handled by user code. They can also be potentially handled by controls through virtual method overrides, such that user code does not receive specific key events. Also, a browser-hosted application has all key events initially processed by the browser host, which might suppress certain key codes or combinations that the browser host reserves.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft