RelayCommand<T>クラス（MVVM Light Toolkit リファレンス）

6190 ワード
MVVMLightToolkit MVVM C# C# テキストリンク

RelayCommand<T>

概要

public class RelayCommand<T> : System.Windows.Input.ICommand
  • ICommandインターフェイスを実装したコマンド。
  • コマンドに渡すCommandParameterの型はTである。
名前空間
  • GalaSoft.MvvmLight.Command
  • GalaSoft.MvvmLight.CommandWpf（WPF バージョン4.5、つまりWindows 8以上はこちらを使うこと）

アセンブリ

  • GalaSoft.MvvmLight
  • GalaSoft.MvvmLight.Platform（GalaSoft.MvvmLight.CommandWpf名前空間）

メソッド

コンストラクター

コンストラクター
public RelayCommand(System.Action<T> execute, bool keepTargetAlive = false)
public RelayCommand(System.Action<T> execute, System.Func<T, bool> canExecute, bool keepTargetAlive = false)
概要
  • executeは、コマンドを実行するときに呼ぶメソッド。
  • canExecuteは、コマンドを実行できるかどうかを判定するメソッド。canExecuteを指定しない場合は、コマンドが常に実行できるとみなす。
  • keepTargetAliveは、executeやcanExecuteがクロージャーの場合、trueにすること。それ以外の場合は、メモリリークを防ぐため、falseにすること。
例外
  • System.ArgumentNullException: executeがnullである。

CanExecute

CanExecute
public bool CanExecute(object parameter)
概要
  • コマンドを実行できるかどうかを判定するメソッド。
  • コンストラクターでcanExecuteを指定していれば、それを呼ぶ。parameterは、Tに型変換してからcanExecuteに渡される。
  • コンストラクターでcanExecuteを指定していなければ、常にtrueを戻す。
戻り値
  • コマンドを実行できる状態ならtrue、実行できないならfalseを戻す。（そのようなcanExecuteを指定すること）

Execute

Execute
public virtual void Execute(object parameter)
概要
  • コマンドの実行そのものであるメソッド。
  • コンストラクターで指定したexecuteを呼ぶ。parameterは、Tに型変換してからexecuteに渡される。

RaiseCanExecuteChanged

RaiseCanExecuteChanged
public void RaiseCanExecuteChanged()
概要
  • このコマンドを実行できるかどうかが変化するときに、このメソッドを呼び出すこと。
  • CanExecuteChangedイベントを起こす。

イベント

CanExecuteChanged

CanExecuteChanged
public event System.EventHandler CanExecuteChanged
概要
  • このコマンドを実行できるかどうかが変化するときに起きるイベント。
  • RaiseCanExecuteChangedメソッドを呼ぶことで、起きる。

参照