KeyEventArgs Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Provides event data for the UIElement.KeyUp and UIElement.KeyDown events.
Inheritance Hierarchy
System.Object
System.EventArgs
System.Windows.RoutedEventArgs
System.Windows.Input.KeyEventArgs
Namespace: System.Windows.Input
Assembly: System.Windows (in System.Windows.dll)
Syntax
'Declaration
Public NotInheritable Class KeyEventArgs _
Inherits RoutedEventArgs
public sealed class KeyEventArgs : RoutedEventArgs
The KeyEventArgs type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") .gif "Supported by Silverlight for Windows Phone") |
Handled | Gets 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. |
|
Key | Gets the keyboard key associated with the event. |
|
OriginalSource | Gets a reference to the object that raised the event. (Inherited from RoutedEventArgs.) |
|
PlatformKeyCode | Gets 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
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
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 Silverlight application has all key events initially processed by the browser host, which might suppress certain key codes or combinations that the browser host reserves. For more information on these key event concepts, see Keyboard Support.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also