InputBinding.CommandParameter プロパティ

定義

名前空間:

System.Windows.Input

アセンブリ:

PresentationCore.dll

特定のコマンドのコマンド固有のデータを取得または設定します。

public:
 property System::Object ^ CommandParameter { System::Object ^ get(); void set(System::Object ^ value); };

public object CommandParameter { get; set; }

member this.CommandParameter : obj with get, set

Public Property CommandParameter As Object

プロパティ値

Object

コマンド固有のデータ。 既定値は、null です。

注釈

プロパティは CommandParameter 、実行時にコマンドに特定の情報を渡すために使用されます。 データの型は、 コマンドによって定義されます。 多くのコマンドでは、コマンド パラメーターは必要ありません。これらのコマンドでは、渡されたコマンド パラメーターはすべて無視されます。

入力バインドが関連付けられているコマンドが である場合、RoutedCommandCommandParameter入力バインディングの は、 コマンドの処理時にRoutedCommand、 および イベント データをCanExecuteRoutedEventArgs介してExecutedRoutedEventArgsハンドラーに渡されます。

コマンド パラメーターのデータ型と目的は、コマンドごとに異なる方法で定義され、 にすることができます null。 、、および CommandTarget の各プロパティICommandは、オブジェクトで定義されている にバインドCommandCommandParameterできます。 これにより、カスタム コマンドを定義し、ユーザー入力に関連付けることができます。 詳細については、 の 2 番目の例を InputBinding参照してください。

クラスは InputBinding 、パブリック パラメーターなしのコンストラクターを公開しないため、XAML の使用をサポートしていません (パラメーターなしのコンストラクターがありますが、保護されています)。 ただし、派生クラスはパブリック コンストラクターを公開できるため、XAML を使用して 継承 InputBinding されるプロパティを設定できます。 XAML でインスタンス化でき、XAML でプロパティを設定できる 2 つの既存InputBindingの派生クラスは と MouseBindingですKeyBinding。

XAML 属性の使用方法

<inputBindingDerivedClass CommandParameter="commandParameterString"/>  

XAML プロパティ要素の使用

<inputBindingDerivedClass>  
  <inputBindingDerivedClass.CommandParameter>  
    <commandParameterObject/>  
  </inputBindingDerivedClass.CommandParameter>  
</inputBindingDerivedClass>  

XAML 値

inputBindingDerivedClass
や MouseBindingなどのKeyBindingオブジェクト要素構文InputBindingをサポートする の派生クラス。 「解説」を参照してください。

commandParameterString
特定のコマンドによって処理される文字列。 文字列は、XAML で簡単に設定できるため、コマンド パラメーターに使用される一般的な型です。 予想される文字列形式とその目的については、入力バインディングが関連付けられている特定のコマンドのドキュメントを参照してください。 多くのコマンドでは、パラメーターは必要ありません。

commandParameterObject
特定のコマンドによって処理される オブジェクト。 既存の WPF コマンドはすべて文字列を使用します。 したがって、このプロパティ要素の構文は、カスタム コマンド のシナリオにのみ関連します。 この構文をサポートするには、オブジェクト要素の commandParameterObject 構文もサポートする必要があります (パブリック パラメーターなしのコンストラクターが必要です)。