深入浅出WPF命令系统之InputBinding（MouseBinding与KeyBinding）

之前的随笔中剖析了WPF命令系统的一部分，文中是通过CommandBinding和Binding两种方式将命令（ICommand）与Button控件进行关联，如下：

方式一. CommandBinding

<Window.Resources>
    <RoutedCommand x:Key="MyTestCommand"/>
</Window.Resources>
<Window.CommandBindings>
    <CommandBinding Command="{StaticResource MyTestCommand}" Executed="CommandBinding_Executed" CanExecute="CommandBinding_CanExecute"/>
</Window.CommandBindings>

<Grid>
    <Button Height="100"
            Width="200"
            Content="click me"
            Command="{StaticResource MyTestCommand}"/>
</Grid>

方式二. Binding（即绑定数据源中的实现了ICommand接口的对象），如

<Grid>
    <Button Height="100"
            Width="200"
            Content="click me"
            Command="{Binding TestCommand}"/>
</Grid>

其中，TestCommand是DataContext中的一个实现了ICommand接口的对象。

上述两种方式，点击Button控件后会执行绑定的命令。但实际开发场景中，如果遇到了Button以外的需求，比如需要通过键盘或者鼠标来触发命令，该怎么办？

对，我们可以通过UIElement中的InputBindings属性来实现。

先来看看具体怎么用吧。

需求1.按下键盘上的指定键时（假设是Ctrl + N）处理某个事情（弹出“Hello world”对话框）

实现如下：

<Window.InputBindings>
    <KeyBinding Command="{Binding KeyCommand}" Gesture="Ctrl+N"/>
</Window.InputBindings>

public partial class MainWindow : Window
{
    public MyCommand KeyCommand { get; }

    public MainWindow()
    {
        InitializeComponent();
        DataContext = this;
        KeyCommand = new MyCommand(OnKeyCommandExecuted);
    } 

    private void OnKeyCommandExecuted(object parameter)
    {
        MessageBox.Show("Hello world");
    }
} 

public class MyCommand : ICommand
{
    private readonly Action<object> _executeMethod;

    public event EventHandler CanExecuteChanged;

    public MyCommand(Action<object> executeMethod)
    {
        _executeMethod = executeMethod;
    }

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

    public void Execute(object parameter)
    {
        _executeMethod?.Invoke(parameter);
    }
}

需求2.操作鼠标上的按键（假设右键双击）后处理某些事情（弹出“你好，世界”对话框）

实现如下：

<Window.InputBindings>
    <MouseBinding Command="{Binding MouseCommand}" MouseAction="RightDoubleClick"/>
</Window.InputBindings>

public partial class MainWindow : Window
{
    public MyCommand MouseCommand { get; }

    public MainWindow()
    {
        InitializeComponent();

        DataContext = this;

        MouseCommand = new MyCommand(OnMouseCommandExecuted);
    }

    private void OnMouseCommandExecuted(object parameter)
    {
        MessageBox.Show("你好，世界");
    }
}

上述两个例子中分别使用了KeyBinding和MouseBinding，它们都是InputBinding的派生类，而UIElement.InputBindings集合的元素类型正是InputBinding。

那KeyBinding和MouseBinding到底是怎么回事呢？请看下文。

KeyBinding

KeyBinding的源码比较简单（感兴趣的小伙伴自行翻看，这里就不展示了），KeyBinding的功能就是将键盘按键和命令关联，所以KeyBinding中关键的元素就是它的Command、Gesture、ModifierKey和Key属性。.net提供了Gesture（KeyGesture）和Modifiers+Key两种方式来关联Command，这两种方式的效果是一样的，但以下几种使用方式是错误的：

1. Gesture和ModifierKey+Key共用，比如既指定了Gesture又指定了Key；
2. Gesture仅指定了Key，没有指定ModifierKey。这种方式编译时没问题，但运行时直接报错。
3. 仅指定ModifierKey，未指定Key；

MS推荐在XAML中使用Gesture（KeyGesture）这种方式，但遗憾的是，KeyGesture还不支持None+Key这种方式，即使用KeyGesture时，必须指定修饰键。

Gesture（KeyGesture）在XAML中的字符串形式是“ModifierKey+Key”，如“Ctrl+N”。.net会通过KeyGestureConverter类型转换器来解析此字符串。

MouseBinding

与KeyBinding类似，MouseBinding的功能是将鼠标操作与命令进行关联。MouseBinding也提供了两种方式来关联命令，它们是Gesture（MouseGesture）和MouseAction（枚举类型），这两种方式也是等效的。在这两种方式共用的情况下，运行时也不会报错，但仅最后声明的方式有效，比如

<MouseBinding Command="{Binding MouseCommand}" Gesture="LeftClick" MouseAction="RightDoubleClick"/>

这时，仅RightDoubleClick有效。

对于MouseBinding，微软也推荐在XAML中使用Gesture。

Gesture（MouseGesture）在XAML中的字符串形式是“ModifierKey+MouseAction”，如“Ctrl+LeftClick”，且可以不指定ModifierKey。

.net会通过MouseGestureConverter类型转换器来解析此字符串。

UIElement中的InputBindings是如何被执行的？

用反编译工具查了一下，并没有发现鼠标或键盘动作时调用InputBindings的相关代码，但是我们看到在UIElement中，InputBindings是这样实现的：

public InputBindingCollection InputBindings
{
    get
    {
        VerifyAccess();
        InputBindingCollection inputBindingCollection = InputBindingCollectionField.GetValue(this);
        if (inputBindingCollection == null)
        {
            inputBindingCollection = new InputBindingCollection(this);
            InputBindingCollectionField.SetValue(this, inputBindingCollection);
        }

        return inputBindingCollection;
    }
}

通过上述代码可以发现，InputBindings实际是对另一个字段InputBindingCollectionField的包装，而在InputBindings属性不远的地方，还有一个属性InputBindingsInternal，它是这样的：

internal InputBindingCollection InputBindingsInternal
{
    get
    {
        VerifyAccess();
        return InputBindingCollectionField.GetValue(this);
    }
}

这两个属性不就是同一个东西嘛，既然如此，不妨找找这个属性，果然看到有人在用它：

而与OnMouseDownThunk、OnMouseWheelThunk和OnKeyDownThunk关联的事件分别是Mouse.MouseDownEvent，Mouse.MouseWheelEvent和Keyboard.KeyDownEvent。

OK，打完收工。