MouseBinding Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Binds a MouseGesture to a RoutedCommand (or another ICommand implementation).

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


public class MouseBinding : InputBinding


Initializes a new instance of the MouseBinding class.

System_CAPS_pubmethodMouseBinding(ICommand, MouseGesture)

Initializes a new instance of the MouseBinding class, using the specified command and mouse gesture.


Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)


Gets or sets the ICommand associated with this input binding. (Inherited from InputBinding.)


Gets or sets the command-specific data for a particular command.(Inherited from InputBinding.)


Gets or sets the target element of the command.(Inherited from InputBinding.)


Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)


Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)


Gets or sets the gesture associated with this MouseBinding. (Overrides InputBinding.Gesture.)


Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)


Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)


Gets or sets the MouseAction associated with this MouseBinding.


Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)


Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)


Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)


Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values. (Inherited from Freezable.)


Copies the base (non-animated) values of the properties of the specified object.(Overrides InputBinding.CloneCore(Freezable).)


Creates a modifiable clone (deep copy) of the Freezable using its current values.(Inherited from Freezable.)


Copies the current values of the properties of the specified object.(Overrides InputBinding.CloneCurrentValueCore(Freezable).)


Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)


Initializes a new instance of the Freezable class. (Inherited from Freezable.)


Creates an instance of an MouseBinding.(Overrides InputBinding.CreateInstanceCore().)


Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)


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


Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)


Makes the Freezable object unmodifiable or tests whether it can be made unmodifiable.(Inherited from Freezable.)


Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)


Creates the instance a frozen clone of the specified Freezable by using base (non-animated) property values.(Overrides InputBinding.GetAsFrozenCore(Freezable).)


Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.(Inherited from Freezable.)


Creates the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied.(Overrides InputBinding.GetCurrentValueAsFrozenCore(Freezable).)


Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)


Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)


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


Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)


Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)


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


Called when the current Freezable object is modified. (Inherited from Freezable.)

System_CAPS_protmethodOnFreezablePropertyChanged(DependencyObject, DependencyObject)

Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.(Inherited from Freezable.)

System_CAPS_protmethodOnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)

This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.(Inherited from Freezable.)


Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable.(Inherited from Freezable.)


Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)


Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties.(Inherited from Freezable.)

System_CAPS_pubmethodSetCurrentValue(DependencyProperty, Object)

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyPropertyKey, Object)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)


Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)


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


Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)


Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties.(Inherited from Freezable.)


Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.)


Identifies the MouseAction dependency property.


Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)

A MouseBinding associates a MouseGesture with an ICommand implementation. RoutedCommand is the primary implementation of the ICommand interface for the WPF commanding system. In general, when the MouseGesture is executed, the command is invoked, although the command behavior is further influenced by command-specific factors such as the CanExecute value. For more information on commanding, see the Commanding Overview.

When defining a MouseBinding in Extensible Application Markup Language (XAML), there are two ways to specify the MouseGesture. The first way to establish a MouseBinding in XAML is to define the Gesture attribute of the MouseBinding element, which enables a syntax to specify mouse actions and modifiers as a single string; for example, "CTRL+LeftClick". The second way is to define the MouseAction attribute of the MouseBinding element. Both ways of setting the MouseGesture are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the MouseAction and the Gesture attributes are both set, the gesture is invalid. In general, it is recommended that you use only the Gesture attribute from XAML, even if you do not specify modifiers; this avoids ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization.

A MouseBinding can be defined on a specific object or at the class level by registering a RegisterClassInputBinding on the CommandManager class. The most typical way to define a MouseBinding is within the control template, setting the InputBindings property in XAML by declaring one or more MouseBinding or KeyBinding elements.

The following example shows how to use a MouseBinding to bind a MouseGesture to a RoutedCommand.

<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;


.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