PreviewKeyDownEventArgs Class
Provides data for the PreviewKeyDown event.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The PreviewKeyDownEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
|
PreviewKeyDownEventArgs | Initializes a new instance of the PreviewKeyDownEventArgs class with the specified key. |
| Name | Description | |
|---|---|---|
|
Alt | Gets a value indicating whether the ALT key was pressed. |
|
|
Control | Gets a value indicating whether the CTRL key was pressed. |
|
|
IsInputKey | Gets or sets a value indicating whether a key is a regular input key. |
|
|
KeyCode | Gets the keyboard code for a KeyDown or KeyUp event. |
|
|
KeyData | Gets the key data for a KeyDown or KeyUp event. |
|
|
KeyValue | Gets the keyboard value for a KeyDown or KeyUp event. |
|
|
Modifiers | Gets the modifier flags for a KeyDown or KeyUp event. |
|
|
Shift | Gets a value indicating whether the SHIFT key was pressed. |
| Name | Description | |
|---|---|---|
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it 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.) |
For more information about handling events, see Consuming Events.
The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the PreviewKeyDown event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing Show with Console.WriteLine or appending the message to a multiline TextBox.
To run the example code, paste it into a project that contains an instance of a type that inherits from Control, such as a Button or ComboBox. Then name the instance Control1 and ensure that the event handler is associated with the PreviewKeyDown event.
private void Control1_PreviewKeyDown(Object sender, PreviewKeyDownEventArgs e) { System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder(); messageBoxCS.AppendFormat("{0} = {1}", "Alt", e.Alt ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "Control", e.Control ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "KeyCode", e.KeyCode ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "KeyValue", e.KeyValue ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "KeyData", e.KeyData ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "Modifiers", e.Modifiers ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "Shift", e.Shift ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "IsInputKey", e.IsInputKey ); messageBoxCS.AppendLine(); MessageBox.Show(messageBoxCS.ToString(), "PreviewKeyDown Event" ); }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
