MouseGesture Class
Defines a mouse input gesture that can be used to invoke a command.
Assembly: PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
The MouseGesture type exposes the following members.
| Name | Description | |
|---|---|---|
 | MouseGesture | Initializes a new instance of the MouseGesture class. |
| MouseGesture(MouseAction) | Initializes a new instance of the MouseGesture class using the specified MouseAction. |
| MouseGesture(MouseAction, ModifierKeys) | Initializes a new instance of the MouseGesture class using the specified MouseAction and ModifierKeys. |
| Name | Description | |
|---|---|---|
| Modifiers | Gets or sets the modifier keys associated with this MouseGesture. |
| MouseAction | Gets or sets the MouseAction associated with this gesture. |
| 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.) |
| Matches | Determines whether MouseGesture matches the input associated with the specified InputEventArgs object. (Overrides InputGesture.Matches(Object, InputEventArgs).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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.
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" />
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)
Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.