WPFでショートカットキーを使用する - プログラムを書こう！

この記事は2020年04月03日に投稿しました。

f:id:paveway:20190914064630j:plain

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回は業務で使用しているWPFでショートカットキーを使用する方法についてです。

目次へ

2. WPFでショートカットキーを使用する

WPFでショートカットキーを使用するには、MVVMにしたがった処理にする必要があります。

実装例

DelegateCommand.cs

DelegateCommandクラスはICommandクラスの実装クラスになります。

using System;
using System.Windows.Input;

namespace WPFShortcutKey
{
    /**
     * @brief コマンドデリゲートクラス
     */
    class DelegateCommand : ICommand
    {
        //! コマンドを実行するためのメソッド
        private Action<object> execute;

        //! コマンドの実行可否を判別するメソッド
        private Func<object, bool> canExecute;

        /**
         * @brief コンストラクタ
         * 
         * @param [in] execute コマンドを実行するためのメソッド
         */
        public DelegateCommand(Action<object> execute) : this(execute, o => true)
        {

        }

        /**
         * @brief コンストラクタ
         * 
         * @param [in] execute コマンドを実行するためのメソッド
         * @param [in] canExecute コマンドの実行可否を判別するメソッド
         */
        public DelegateCommand(Action<object> execute, Func<object, bool> canExecute)
        {
            this.execute = execute;
            this.canExecute = canExecute;
        }

        /**
         * @brief コマンドの実行可否を判別します。
         * 
         * @param [in] パラメータ
         * @return 判別結果(true:実行可能/false:実行不可)
         */
        public bool CanExecute(object parameter)
        {
            return canExecute == null ? true : canExecute(parameter);
        }

        /**
         * @brief コマンドを実行します。
         * 
         * @param [in] parameter パラメータ
         */
        public void Execute(object parameter)
        {
            // コマンドを実行するメソッドが無効な場合
            if (execute == null)
            {
                // 何もしない。
                return;
            }

            // コマンドを実行します。
            execute(parameter);
        }

        //! コマンドを実行するかどうかに影響するような変更があった場合に発生します。
        public event EventHandler CanExecuteChanged
        {
            add
            {
                CommandManager.RequerySuggested += value;
            }
            remove
            {
                CommandManager.RequerySuggested -= value;
            }
        }

        public static void RaiseCanExecuteChanged()
        {
            // RequerySuggestedイベントを強制的に発生させます。
            CommandManager.InvalidateRequerySuggested();
        }
    }
}

MainWindowViewModel.cs

using System.Windows;

namespace WPFShortcutKey
{
    class MainWindowViewModel
    {
        //! Ctrl+Cのコマンドオブジェクト
        public DelegateCommand CopyCommand { get; private set; }

        //! Ctrl+Vのコマンドオブジェクト
        public DelegateCommand PasteCommand { get; private set; }

        /**
         * @brief コンストラクタ
         */
        public MainWindowViewModel()
        {
            // コマンドオブジェクトと呼び出されるメソッドを関連付けます。
            CopyCommand = new DelegateCommand(CopyCommandBody);
            PasteCommand = new DelegateCommand(PasteCommandBody);
        }

        /**
         * @brief Ctrl+Cが押下された時呼び出されます。
         */
        private void CopyCommandBody(object sender)
        {
            MessageBox.Show("コピー");
        }

        /**
         * @brief Ctrl+Vが押下された時呼び出されます。
         */
        private void PasteCommandBody(object sender)
        {
            MessageBox.Show("貼り付け");
        }
    }
}

MainWindow.xaml

<Window x:Class="WPFShortcutKey.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WPFShortcutKey"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800">
    <!-- ショートカットキーとコマンドオブジェクトを関連付けます -->
    <Window.InputBindings>
        <KeyBinding Gesture="Ctrl+C" Command="{Binding CopyCommand}"/>
        <KeyBinding Gesture="Ctrl+V" Command="{Binding PasteCommand}"/>
    </Window.InputBindings>
    <Grid>
        
    </Grid>
</Window>

MainWindow.xaml.cs

using System.Windows;

namespace WPFShortcutKey
{
    /// <summary>
    /// MainWindow.xaml の相互作用ロジック
    /// </summary>
    public partial class MainWindow : Window
    {
        /**
         * @brief コンストラクタ
         */
        public MainWindow()
        {
            InitializeComponent();

            // ViewModelを関連付けます。
            DataContext = new MainWindowViewModel();
        }
    }
}

API Reference

ICommandインターフェース

CommandManagerクラス

目次へ

3. おわりに

メニューのショートカットキーを実装しようとしましたが、簡単にできる方法がわかりませんでした。
調べてく行くと、MVVMに従った処理が必要なことがわかりました。
めんどくさいです。

リンク

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ