PreviewKeyDownEventArgs Class
TOC
Collapse the table of content
Expand the table of content

PreviewKeyDownEventArgs Class

 

Provides data for the PreviewKeyDown event.

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

System.Object
  System.EventArgs
    System.Windows.Forms.PreviewKeyDownEventArgs

public class PreviewKeyDownEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodPreviewKeyDownEventArgs(Keys)

Initializes a new instance of the PreviewKeyDownEventArgs class with the specified key.

NameDescription
System_CAPS_pubpropertyAlt

Gets a value indicating whether the ALT key was pressed.

System_CAPS_pubpropertyControl

Gets a value indicating whether the CTRL key was pressed.

System_CAPS_pubpropertyIsInputKey

Gets or sets a value indicating whether a key is a regular input key.

System_CAPS_pubpropertyKeyCode

Gets the keyboard code for a KeyDown or KeyUp event.

System_CAPS_pubpropertyKeyData

Gets the key data for a KeyDown or KeyUp event.

System_CAPS_pubpropertyKeyValue

Gets the keyboard value for a KeyDown or KeyUp event.

System_CAPS_pubpropertyModifiers

Gets the modifier flags for a KeyDown or KeyUp event.

System_CAPS_pubpropertyShift

Gets a value indicating whether the SHIFT key was pressed.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

For more information about handling events, see Handling and Raising 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" );
}

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft