MouseGesture Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines a mouse input gesture that can be used to invoke a command.
public ref class MouseGesture : System::Windows::Input::InputGesture[System.ComponentModel.TypeConverter(typeof(System.Windows.Input.MouseGestureConverter))]
public class MouseGesture : System.Windows.Input.InputGesture[<System.ComponentModel.TypeConverter(typeof(System.Windows.Input.MouseGestureConverter))>]
type MouseGesture = class
inherit InputGesturePublic Class MouseGesture
Inherits InputGesture- Inheritance
- Attributes
Examples
The following example shows to create a MouseGesture and associate it with a RoutedCommand through a MouseBinding. When the mouse wheel is clicked while the Control key is pressed, the Open is invoked.
<MouseBinding Gesture="Control+WheelClick"
Command="ApplicationCommands.Open" />
MouseGesture OpenCmdMouseGesture = new MouseGesture();
OpenCmdMouseGesture.MouseAction = MouseAction.WheelClick;
OpenCmdMouseGesture.Modifiers = ModifierKeys.Control;
MouseBinding OpenCmdMouseBinding = new MouseBinding();
OpenCmdMouseBinding.Gesture = OpenCmdMouseGesture;
OpenCmdMouseBinding.Command = ApplicationCommands.Open;
this.InputBindings.Add(OpenCmdMouseBinding);
Dim OpenCmdMouseGesture As New MouseGesture()
OpenCmdMouseGesture.MouseAction = MouseAction.WheelClick
OpenCmdMouseGesture.Modifiers = ModifierKeys.Control
Dim OpenCmdMouseBinding As New MouseBinding()
OpenCmdMouseBinding.Gesture = OpenCmdMouseGesture
OpenCmdMouseBinding.Command = ApplicationCommands.Open
Me.InputBindings.Add(OpenCmdMouseBinding)
Remarks
Unlike a KeyGesture, a MouseAction does not have to be paired with ModifierKeys to be a valid MouseGesture.
A MouseGesture can be bound to a RoutedCommand (or other ICommand implementations) through a MouseBinding so that the command is invoked when the MouseGesture occurs.
For MouseGesture XAML attribute usages, the property that is generally set in XAML is Gesture, in cases where the gesture can represent both a mouse action and one or more modifier key. You can also set the Gesture property to be just a mouse action. In general, it is recommended that you use only the Gesture attribute from XAML, rather than setting MouseAction, even if you do not specify modifiers. This will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization.
MouseGesture XAML object element usages are possible but uncommon, because you can ordinarily set the Gesture property of MouseBinding inline without the use of property element syntax.
XAML Attribute Usage
<object property="mouseAction"/>
- or -
<object property="oneOrMoreModifierKeys+mouseAction"/>
XAML Values
mouseAction
MouseAction
A single mouse action.
oneOrMoreModifierKeys
One or more modifier keys, defined by the ModifierKeys enumeration. If more than one modifier key is provided, each modifier key is delimited with a "+" character.
Constructors
| MouseGesture() |
Initializes a new instance of the MouseGesture class. |
| MouseGesture(MouseAction, ModifierKeys) |
Initializes a new instance of the MouseGesture class using the specified MouseAction and ModifierKeys. |
| MouseGesture(MouseAction) |
Initializes a new instance of the MouseGesture class using the specified MouseAction. |
Properties
| Modifiers |
Gets or sets the modifier keys associated with this MouseGesture. |
| MouseAction |
Gets or sets the MouseAction associated with this gesture. |
Methods
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| Matches(Object, InputEventArgs) |
Determines whether MouseGesture matches the input associated with the specified InputEventArgs 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) |
