WPFのキーボードショートカット


129

_代わりにを使用することはわかっ&ていますが、すべてのCtrl+タイプのショートカットを調べています。

Ctrl+ Z取り消し、Ctrl+ S保存など

これらをWPFアプリケーションに実装するための「標準」の方法はありますか?それとも、あなた自身のものを転がして、それらをどんなコマンド/コントロールにでも配線するケースですか?

回答:


170

1つの方法は、ショートカットキーをコマンド自体にとして追加することInputGesturesです。コマンドはとして実装されRoutedCommandsます。

これにより、ショートカットキーがコントロールに接続されていなくても機能します。また、メニュー項目はキーボードジェスチャーを理解するため、メニュー項目にコマンドをフックすると、メニュー項目のテキストにショートカットキーが自動的に表示されます。

  1. コマンドを保持する静的属性を作成します(できれば、コマンド用に作成した静的クラスのプロパティとして、単純な例として、window.csで静的属性を使用するだけです)。

     public static RoutedCommand MyCommand = new RoutedCommand();
  2. メソッドを呼び出すショートカットキーを追加します。

     MyCommand.InputGestures.Add(new KeyGesture(Key.S, ModifierKeys.Control));
  3. 実行時に呼び出すメソッドを指すコマンドバインディングを作成します。これらを動作させる必要のあるUI要素(ウィンドウなど)とメソッドのコマンドバインディングにこれらを配置します。

     <Window.CommandBindings>
         <CommandBinding Command="{x:Static local:MyWindow.MyCommand}" Executed="MyCommandExecuted"/>
     </Window.CommandBindings>
    
     private void MyCommandExecuted(object sender, ExecutedRoutedEventArgs e) { ... }

4
コマンドをメニュー項目に関連付けるにはどうすればよいですか?確かに、これはこの回答に含める最も重要な情報ですが、それが欠けています。
ティムウィ

8
@Timwi:上記のコードを使用して、既存のイベントにキーボードショートカットを追加しました。RoutedCommand cmndSettings = new RoutedCommand(); cmndSettings.InputGestures.Add(new KeyGesture(Key.S、ModifierKeys.Control)); CommandBindings.Add(new CommandBinding(cmndSettings、mnuSettings_Click));
itho 2012年

1
itshoのコメントは私にとってこの仕事をしました、上のxmlコードを機能させることができませんでした。
gosr

1
残念ながら、このアプローチではExecuted、コマンドのコードは、通常のコマンド(カスタムICommand実装)を使用するのではなく、ビューモデルではなく(ウィンドウまたはユーザーコントロールの)コードビハインドになります。
ORマッパー14


97

これは、WPFのキーバインディングに関連して、まさに私が探していたものであることがわかりました。

<Window.InputBindings>
        <KeyBinding Modifiers="Control"
                    Key="N"
                    Command="{Binding CreateCustomerCommand}" />
</Window.InputBindings>

ブログ投稿のMVVM CommandReferenceとKeyBindingを参照してください


とても素敵で簡単です!
合併

1
「CreateCustomerCommand」とは何か、それをどのように実装するかについて詳しく説明していただけませんか。
Vinz、

リンク先のブログ投稿で、コピー&貼り付けされたコードスニペットが「結果は例外になります」と記載されているため、これはまだリンクのみの回答です。:P
Martin Schneider

作品はここで驚異的です。最初に、OPのようにボタンコンテンツのキーの前に "_"を追加しようとしましたが、機能しませんでした。最悪の場合、インターフェイスの書き込み可能なオブジェクトにフォーカスがなかったときに、キー自体を押すとアクティブになりました。保存には「ctrl-s」ではなく「s」を使用します。
ジェイ

14

このコードを試してください...

最初にRoutedComandオブジェクトを作成します

  RoutedCommand newCmd = new RoutedCommand();
  newCmd.InputGestures.Add(new KeyGesture(Key.N, ModifierKeys.Control));
  CommandBindings.Add(new CommandBinding(newCmd, btnNew_Click));

9

どこで使いたいかによります。

TextBoxBaseから派生したコントロールはすでにこれらのショートカットを実装しています。カスタムのキーボードショートカットを使用する場合は、コマンドと入力ジェスチャーをご覧ください。以下は、Switch on the Codeの小さなチュートリアルです。WPFチュートリアル-コマンドバインディングとカスタムコマンド


8
なんてがらくたのチュートリアル—すべての中で最も重要なことを説明していません。それは、20の「一般的な」コマンドの事前定義されたセットの1つではないコマンドの使用方法です。
ティムウィ

6

他の人のためにこの答えを文書化します。これはめったに参照されず、XAMLを操作する必要がないため、これを行うはるかに簡単な方法があります。

キーボードショートカットをリンクするには、Windowコンストラクターで、新しいKeyBindingをInputBindingsコレクションに追加するだけです。コマンドとして、ICommandを実装する任意のコマンドクラスを渡します。executeメソッドの場合、必要なロジックを実装するだけです。以下の私の例では、WindowCommandクラスは、呼び出されるたびに実行されるデリゲートを取ります。バインディングで渡す新しいWindowCommandを作成するときは、初期化子でWindowCommandに実行させたいメソッドを指定するだけです。

このパターンを使用して、独自のクイックキーボードショートカットを作成できます。

public YourWindow() //inside any WPF Window constructor
{
   ...
   //add this one statement to bind a new keyboard command shortcut
   InputBindings.Add(new KeyBinding( //add a new key-binding, and pass in your command object instance which contains the Execute method which WPF will execute
      new WindowCommand(this)
      {
         ExecuteDelegate = TogglePause //REPLACE TogglePause with your method delegate
      }, new KeyGesture(Key.P, ModifierKeys.Control)));
   ...
}

実行デリゲートを受け取り、それに設定されたメソッドを起動する単純なWindowCommandクラスを作成します。

public class WindowCommand : ICommand
{
    private MainWindow _window;

    //Set this delegate when you initialize a new object. This is the method the command will execute. You can also change this delegate type if you need to.
    public Action ExecuteDelegate { get; set; }

    //You don't have to add a parameter that takes a constructor. I've just added one in case I need access to the window directly.
    public WindowCommand(MainWindow window)
    {
        _window = window;
    }

    //always called before executing the command, mine just always returns true
    public bool CanExecute(object parameter)
    {
        return true; //mine always returns true, yours can use a new CanExecute delegate, or add custom logic to this method instead.
    }

    public event EventHandler CanExecuteChanged; //i'm not using this, but it's required by the interface

    //the important method that executes the actual command logic
    public void Execute(object parameter)
    {
        if (ExecuteDelegate != null)
        {
            ExecuteDelegate();
        }
        else
        {
            throw new InvalidOperationException();
        }
    }
}

5

同様の問題があり、@ aliwaの回答が最も役立つ最もエレガントなソリューションであることがわかりました。ただし、特定のキーの組み合わせCtrl+が必要でした1。残念ながら、次のエラーが発生しました。

「1」は「キー」の値として使用できません。数値は有効な列挙値ではありません。

少し検索して、@ aliwaの回答を次のように変更しました。

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

私はこれが私が必要とするどんな組み合わせでもかなりうまくいくことを発見しました。


これは私にとっては<UserControl.InputBindings> <KeyBinding Gesture="Enter" Command="{Binding someCommand}"/> </UserControl.InputBindings>
うまくいっ

3

VB.NET:

Public Shared SaveCommand_AltS As New RoutedCommand

ロードされたイベントの内部:

SaveCommand_AltS.InputGestures.Add(New KeyGesture(Key.S, ModifierKeys.Control))

Me.CommandBindings.Add(New CommandBinding(SaveCommand_AltS, AddressOf Me.save))

XAMLは必要ありません。


1

上位の回答は正解ですがUIElement、特にWindowフォーカスする必要のある要素をが認識していない場合は、個人的に添付プロパティを使用してソリューションをany に適用できるようにします。私の経験では、いくつかのビューモデルとユーザーコントロールの構成をよく見ます。ウィンドウは、ルートコンテナーにすぎません。

スニペット

public sealed class AttachedProperties
{
    // Define the key gesture type converter
    [System.ComponentModel.TypeConverter(typeof(System.Windows.Input.KeyGestureConverter))]
    public static KeyGesture GetFocusShortcut(DependencyObject dependencyObject)
    {
        return (KeyGesture)dependencyObject?.GetValue(FocusShortcutProperty);
    }

    public static void SetFocusShortcut(DependencyObject dependencyObject, KeyGesture value)
    {
        dependencyObject?.SetValue(FocusShortcutProperty, value);
    }

    /// <summary>
    /// Enables window-wide focus shortcut for an <see cref="UIElement"/>.
    /// </summary>
    // Using a DependencyProperty as the backing store for FocusShortcut.  This enables animation, styling, binding, etc...
    public static readonly DependencyProperty FocusShortcutProperty =
        DependencyProperty.RegisterAttached("FocusShortcut", typeof(KeyGesture), typeof(AttachedProperties), new FrameworkPropertyMetadata(null, FrameworkPropertyMetadataOptions.None, new PropertyChangedCallback(OnFocusShortcutChanged)));

    private static void OnFocusShortcutChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        if (!(d is UIElement element) || e.NewValue == e.OldValue)
            return;

        var window = FindParentWindow(d);
        if (window == null)
            return;

        var gesture = GetFocusShortcut(d);
        if (gesture == null)
        {
            // Remove previous added input binding.
            for (int i = 0; i < window.InputBindings.Count; i++)
            {
                if (window.InputBindings[i].Gesture == e.OldValue && window.InputBindings[i].Command is FocusElementCommand)
                    window.InputBindings.RemoveAt(i--);
            }
        }
        else
        {
            // Add new input binding with the dedicated FocusElementCommand.
            // see: https://gist.github.com/shuebner20/349d044ed5236a7f2568cb17f3ed713d
            var command = new FocusElementCommand(element);
            window.InputBindings.Add(new InputBinding(command, gesture));
        }
    }
}

この添付プロパティを使用すると、任意のUIElementのフォーカスショートカットを定義できます。要素を含むウィンドウで入力バインディングを自動的に登録します。

使用法(XAML)

<TextBox x:Name="SearchTextBox"
         Text={Binding Path=SearchText}
         local:AttachedProperties.FocusShortcutKey="Ctrl+Q"/>

ソースコード

FocusElementCommand実装を含む完全なサンプルは、gistとして入手できます。https://gist.github.com/shuebner20/c6a5191be23da549d5004ee56bcc352d

免責事項:このコードはどこでも無料で使用できます。これは大量の使用には適さないサンプルであることを覚えておいてください。たとえば、コマンドは要素への強い参照を保持するため、削除された要素のガベージコレクションはありません。


弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.