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

KeyGesture Class

 

Defines a keyboard combination that can be used to invoke a command.

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

System.Object
  System.Windows.Input.InputGesture
    System.Windows.Input.KeyGesture

<TypeConverterAttribute(GetType(KeyGestureConverter))>
Public Class KeyGesture
	Inherits InputGesture

NameDescription
System_CAPS_pubmethodKeyGesture(Key)

Initializes a new instance of the KeyGesture class with the specified Key.

System_CAPS_pubmethodKeyGesture(Key, ModifierKeys)

Initializes a new instance of the KeyGesture class with the specified Key and ModifierKeys.

System_CAPS_pubmethodKeyGesture(Key, ModifierKeys, String)

Initializes a new instance of the KeyGesture class with the specified Key, ModifierKeys, and display string.

NameDescription
System_CAPS_pubpropertyDisplayString

Gets a string representation of this KeyGesture.

System_CAPS_pubpropertyKey

Gets the key associated with this KeyGesture.

System_CAPS_pubpropertyModifiers

Gets the modifier keys associated with this KeyGesture.

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_pubmethodGetDisplayStringForCulture(CultureInfo)

Returns a string that can be used to display the KeyGesture.

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_pubmethodMatches(Object, InputEventArgs)

Determines whether this KeyGesture matches the input associated with the specified InputEventArgs object.(Overrides InputGesture.Matches(Object, InputEventArgs).)

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.)

In most cases, a KeyGesture must be associated with one or more ModifierKeys. The exceptions to this rule are the function keys and the numeric keypad keys, which can be a valid KeyGesture by themselves. For example, you can create a KeyGesture by using only the F12 key, but to use the X key in a KeyGesture it must be paired with a modifier key.

In general, you can

You can use a KeyBinding to bind a KeyGesture to an ICommand, so that the command is invoked when the KeyGesture occurs.

For KeyGesture XAML usages, the property that is generally set in XAML is Gesture, in cases where the gesture represents both a standard key and a modifier key. You can also set the Gesture property to be just a function key, or just a modifier key combination. However, it is more common to set the Key property if the intended command binding is a function key with no modifiers, or Modifiers if the intended command binding is for modifier keys only.

<object property="oneOrMoreModifierKeys+key"/>
- or -
<object property="functionKey"/>

functionKey

Key

A single key value, which must be one of the function keys (F1-12) or numeric keypad keys.

oneOrMoreModifierKeys

One or more modifier keys, defined by the ModifierKeys enumeration, delimited with a "+" character.

key

Key

A single key value.

The following example shows how to bind the Close command to a KeyGesture using a KeyBinding.

Dim CloseCmdKeyGesture As New KeyGesture(Key.L, ModifierKeys.Alt)

Dim CloseKeyBinding As New KeyBinding(ApplicationCommands.Close, CloseCmdKeyGesture)

Me.InputBindings.Add(CloseKeyBinding)

The following example shows how to use KeyGesture in XAML. Note that the XAML usage does not directly declare a <KeyGesture> element. That object element usage is not possible because KeyGesture does not expose a public default constructor. Instead, the XAML usage uses the typeconverter behavior to declare an entire KeyGesture inline as the Gesture attribute value.

<Window.InputBindings>
  <KeyBinding Command="ApplicationCommands.Open"
              Gesture="CTRL+R" />
</Window.InputBindings>

.NET Framework
Available since 3.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