【WPF】ボタンにEnter,スペースキーが吸われるのを防ぐ方法2選

こんにちは、働くC#プログラマーのさんさめです。

WPFでスペースキーに
処理をアサインした経験はあるでしょうか。

WPFでスペースキーやEnterキーをよく押す
アプリケーションを開発する場合、
ボタンにキー入力が吸われてしまう可能性を
考慮に入れておく必要があります。

というのも、
KeyBindingでSpaceを使っているコントロール内にボタンを置くと
ボタンをクリックした時に
そのボタンにフォーカスが合った状態になり、
スペースキーやEnterキーの入力を
優先して処理してしまうのです。

この挙動は、
他のコントロールにフォーカスが移るまで、
ずっと続きます。

すると、どうなるでしょうか。
「なんかたまにスペースキーが効かないアプリ」
とユーザーに烙印を押されてしまうわけです。

さんさめ

それだけはなんとしても避けたい

この状態に陥らないようにする方法には、
2つの異なるアプローチがあるので、
それぞれを説明していきたいと思います。

KeyBindingではなくPreviewKeyDownイベントを使う
ボタンのFocusableフラグをfalseにする
Enterやスペースキーに処理をアサインしない
まとめ
関連記事

KeyBindingではなくPreviewKeyDownイベントを使う

コードビハインドで
PreviewKeyDownイベントを購読すると、
ボタンまでイベントが伝搬する前に
キー入力を拾うことができます。

コードサンプルは以下のようになります。

protected override void OnPreviewKeyDown(KeyEventArgs e)
{
    base.OnPreviewKeyDown(e);

    if (e.Key == Key.Space)
    {
        // 実行したい処理
        TextUpdateCommand.Execute(null, null);
        e.Handled = true;
    }
}

この方法には欠点もあります。
PreviewKeyDownでハンドリングしてしまうと、
あらゆるスペースキー入力を全て購読してしまうため、
スペースを使いたい別のケースの対処が難しいです。

有名どころとしては、
テキストボックスに半角スペースを入力できなくなります。

さんさめ

一応、日本語入力なら変換とかはできる。一応

また、コードビハインドに書く場合、
そのままではMVVMに適さない
ということに注意しましょう。

MVVMに適さないってどういうこと？

例えば、MVVMでよくあるICommandを使っている
ケースを考えてみます。

実行したい処理の指定をICommandを
Bindingする形で行っていた場合、
Viewはどんな処理を実行すべきなのか分かりません。

以下のように書けば動くことは動きますが、
ViewがViewModelを知っている
（＝特定のViewModelでないと正常動作しない）
ということになります。

protected override void OnPreviewKeyDown(KeyEventArgs e)
{
    base.OnPreviewKeyDown(e);

    if (e.Key == Key.Space)
    {
        (this.DataContext as MyViewModel)?.HogeCommand.Execute(null);
        e.Handled = true;
    }
}

PreviewKeyDownイベントとICommandをつなぐマークアップ拡張
などを併用するとMVVMパターンを崩さずに実装できます。