DelegateCommand クラス
(2017/03/07 15:37:04 created.)
ボタンの Command プロパティなどとデータバインディングするために、ICommand インターフェースを実装した DelegateCommand クラスを次のように定義します。
DelegateCommand.cs
using System;
using System.Windows.Input;
/// <summary>
/// ICommand インターフェースを実装したコマンド用のクラスを表します。
/// </summary>
public class DelegateCommand : ICommand
{
#region private フィールド
/// <summary>
/// コマンドを実行するためのメソッドを保持します。
/// </summary>
private Action<object> _execute;
/// <summary>
/// コマンドの実行可能性を判別するためのメソッドを保持します。
/// </summary>
private Func<object, bool> _canExecute;
#endregion private フィールド
#region コンストラクタ
/// <summary>
/// 新しいインスタンスを生成します。
/// </summary>
/// <param name="execute">コマンドを実行するためのメソッドを指定します。</param>
public DelegateCommand(Action<object> execute)
: this(execute, null)
{
}
/// <summary>
/// 新しいインスタンスを生成します。
/// </summary>
/// <param name="execute">コマンドを実行するためのメソッドを指定します。</param>
/// <param name="canExecute">コマンドの実行可能性を判別するためのメソッドを指定します。</param>
public DelegateCommand(Action<object> execute, Func<object, bool> canExecute)
{
this._execute = execute;
this._canExecute = canExecute;
}
#endregion コンストラクタ
#region ICommand のメンバ
/// <summary>
/// コマンドの実行可能性を判別します。
/// </summary>
/// <param name="parameter">この処理に対するパラメータを指定します。</param>
/// <returns>コマンドが実行可能である場合に true を返します。</returns>
public bool CanExecute(object parameter)
{
return this._canExecute != null ? this._canExecute(parameter) : true;
}
/// <summary>
/// コマンドの実行可能性が変更されたときに発生します。
/// </summary>
public event System.EventHandler CanExecuteChanged
{
add { CommandManager.RequerySuggested += value; }
remove { CommandManager.RequerySuggested -= value; }
}
/// <summary>
/// コマンドを実行します。
/// </summary>
/// <param name="parameter">この処理に対するパラメータを指定します。</param>
public void Execute(object parameter)
{
if (this._execute != null)
this._execute(parameter);
}
#endregion ICommand のメンバ
}
実際に処理する内容や、実行可能かどうかを判別するための処理はコマンドによって異なるため、これらの処理を直接このクラス内で記述するのではなく、private なフィールドである _execute と _canExecute 変数で保持します。
DelegateCommand クラスの使用例は次のようになります。
SampleViewModel.cs
/// <summary>
/// DelegaeCommand クラスの使用例を示すためのクラスを表します。
/// </summary>
public class SampleViewModel : NotificationObject
{
private double _lhs;
/// <summary>
/// 割られる数を取得または設定します。
/// </summary>
public double Lhs
{
get { return this._lhs; }
set { SetProperty(ref this._lhs, value); }
}
private double _rhs;
/// <summary>
/// 割る数を取得または設定します。
/// </summary>
public double Rhs
{
get { return this._rhs; }
set { SetProperty(ref this._rhs, value); }
}
private double _answer;
/// <summary>
/// 計算結果を取得します。
/// </summary>
public double Answer
{
get { return this._answer; }
private set { SetProperty(ref this._answer, value); }
}
private DelegateCommand _divideCommand;
/// <summary>
/// 割り算コマンドを取得します。
/// </summary>
public DelegateCommand DivideCommand
{
get
{
return this._divideCommand ?? (this._divideCommand = new DelegateCommand(
_ =>
{
// ここにはコマンドとして実行する処理を記述します。
// 割り算をおこないます。
this.Answer = this.Lhs / this.Rhs;
},
_ =>
{
// ここには実行可能性を判別する処理を記述します。
// 割る数がゼロ以外のときに割り算が実行できます。
return this.Rhs != 0.0;
}));
}
}
}
DelegateCommand クラスのコンストラクタでは、第一引数にコマンドとして実行する処理を、第二引数としてコマンドの実行可能判別をおこなう処理を指定します。使用例のように、ラムダ式による表現を用いる方法が一般的に使われます。常に実行可能であるコマンドの場合は、コンストラクタの第二引数を省略することができます。
上記のラムダ式では入力引数を使用しないので "_" という変数名としていますが、CommandParaneter を受け取る場合は、適宜変数名を変更したほうが良いでしょう。
Tweet