InputBinding Class
Collapse the table of content
Expand the table of content

InputBinding Class


Represents a binding between an InputGesture and a command. The command is potentially a RoutedCommand.

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


public class InputBinding : Freezable, ICommandSource


Provides base initialization for classes derived from InputBinding.

System_CAPS_pubmethodInputBinding(ICommand, InputGesture)

Initializes a new instance of the InputBinding class with the specified command and input 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.


Gets or sets the command-specific data for a particular command.


Gets or sets the target element of the command.


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 InputGesture associated with this input binding.


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


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 Freezable.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 Freezable.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 InputBinding.(Overrides Freezable.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.)


Makes the instance a frozen clone of the specified Freezable by using base (non-animated) property values.(Overrides Freezable.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.)


Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied.(Overrides Freezable.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 CommandParameter dependency property.


Identifies the Command dependency property.


Identifies the CommandTarget dependency property.


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

You can specify that user input invokes a command by creating a InputBinding. When the user performs the specified input, the ICommand that is set to the Command property is executed.

You can specify that the InputBinding invokes a command that is defined on an object by creating a binding on the Command, CommandParameter, and CommandTarget properties. This enables you to define a custom command and associate it with user input. For more information, see the second example in the Examples section.

An InputBinding can be defined on a specific object or at the class level by registering a RegisterClassInputBinding with the CommandManager.

The InputBinding class itself does not support XAML usage because it does not expose a public default constructor (there is a default constructor, but it is protected). However, derived classes can expose a public constructor and therefore can set properties on the derived class that are inherited from InputBinding with a XAML usage. Two existing InputBinding-derived classes that can be instantiated in XAML and can set properties in XAML are KeyBinding and MouseBinding. The typical property in WPF programming that is set in XAML and takes one or more InputBinding objects as values is the UIElement.InputBindings property.



A derived class of InputBinding that supports object element syntax, such as KeyBinding or MouseBinding. See Remarks.

The following example shows how to use a KeyBinding to bind a KeyGesture to the Open command. When the key gesture is performed, the Open command is invoked.

  <KeyBinding Key="B"
              Command="ApplicationCommands.Open" />

The following examples show how to bind a custom command to InputBinding objects. These examples create an application that enables the user to change the background color by performing one of the following actions:

  • Clicking a button.

  • Pressing CTRL+C.

  • Right-clicking a StackPanel (outside the ListBox).

The first example creates a class named SimpleDelegateCommand. This class accepts a delegate so that the object creating the command can define the action that occurs when the command executes. SimpleDelegateCommand also defines properties that specify what key and mouse input invokes the command. GestureKey and GestureModifier specify the keyboard input; MouseGesture specifies the mouse input.

 // Create a class that implements ICommand and accepts a delegate.
public class SimpleDelegateCommand : ICommand
    // Specify the keys and mouse actions that invoke the command. 
    public Key GestureKey { get; set; }
    public ModifierKeys GestureModifier { get; set; }
    public MouseAction MouseGesture { get; set; }

    Action<object> _executeDelegate;

    public SimpleDelegateCommand(Action<object> executeDelegate)
        _executeDelegate = executeDelegate;

    public void Execute(object parameter)

    public bool CanExecute(object parameter) { return true; }
    public event EventHandler CanExecuteChanged;

The following example creates and initializes the ColorChangeCommand, which is a SimpleDelegateCommand. The example also defines the method that executes when the command is invoked and sets the GestureKey, GestureModifier, and MouseGesture properties. An application would call the InitializeCommand method when the program begins, such as in the constructor of a Window.

public SimpleDelegateCommand ChangeColorCommand
    get { return changeColorCommand; }

private SimpleDelegateCommand changeColorCommand;

private void InitializeCommand()
    originalColor = this.Background;

    changeColorCommand = new SimpleDelegateCommand(x => this.ChangeColor(x));

    DataContext = this;
    changeColorCommand.GestureKey = Key.C;
    changeColorCommand.GestureModifier = ModifierKeys.Control;
    ChangeColorCommand.MouseGesture = MouseAction.RightClick;

private Brush originalColor, alternateColor;

// Switch the Background color between
// the original and selected color.
private void ChangeColor(object colorString)
    if (colorString == null)

    Color newColor = 

    alternateColor = new SolidColorBrush(newColor);

    if (this.Background == originalColor)
        this.Background = alternateColor;
        this.Background = originalColor;

Finally, the following example creates the user interface. The example adds a KeyBinding and a MouseBinding to a StackPanel that contains a Button and a ListBox. When the user selects an item in the ListBox, he or she can change the color of the background to the selected color. In each case, the CommandParameter property is bound to the selected item in the ListBox, and the Command property is bound to the ColorChangeCommand. The KeyBinding.Key, KeyBinding.Modifiers, and MouseBinding.MouseAction properties are bound to the corresponding properties on the SimpleDelegateCommand class.

<StackPanel Background="Transparent">

    <KeyBinding Command="{Binding ChangeColorCommand}"
                CommandParameter="{Binding ElementName=colorPicker, Path=SelectedItem}"
                Key="{Binding ChangeColorCommand.GestureKey}"
                Modifiers="{Binding ChangeColorCommand.GestureModifier}"/>

    <MouseBinding Command="{Binding ChangeColorCommand}"
                  CommandParameter="{Binding ElementName=colorPicker, Path=SelectedItem}"
                  MouseAction="{Binding ChangeColorCommand.MouseGesture}"/>


  <Button Content="Change Color" 
          Command="{Binding ChangeColorCommand}" 
          CommandParameter="{Binding ElementName=colorPicker, Path=SelectedItem}">

  <ListBox Name="colorPicker"

.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
© 2015 Microsoft