XamlUICommand クラス

リファレンス

定義

名前空間:: Windows.UI.Xaml.Input

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

呼び出されたときにアクションを実行する対話型 UI 要素のコマンド動作を定義するための基本クラスを提供します (電子メールの送信、アイテムの削除、フォームの送信など)。

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class XamlUICommand : DependencyObject, ICommand

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class XamlUICommand : DependencyObject, ICommand

Public Class XamlUICommand
Inherits DependencyObject
Implements ICommand

継承: Object IInspectable DependencyObject XamlUICommand

派生: Windows.UI.Xaml.Input.StandardUICommand

属性: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

実装: ICommand ICommand

Windows の要件

デバイスファミリ	Windows 10, version 1809 (10.0.17763.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v7.0 で導入)

例

ヒント

詳細、設計ガイダンス、およびコード例については、「コマンドデザインの基本」を参照してください。

WinUI 2 ギャラリー アプリがインストールされている場合は、ここをクリックしてアプリを開き、StandardUICommand の動作を確認してください。

注釈

ICommand インターフェイス (C++ の場合は Windows.UI.Xaml.Input.ICommand または C# の場合は System.Windows.Input.ICommand ) を実装し、さまざまな UI プロパティ、メソッド、およびイベントを追加します。

XamlUICommand 派生クラス

XamlUICommand は StandardUICommand の親クラスであり、定義済みのプロパティを持つ一連の標準プラットフォームコマンドを公開します。

基本的なコマンドの例については、ボタンコントロールを参照してください。これは、ユーザーがボタンをクリックしたときに何かを起こすために設計されています。

Button コマンドを処理するには、次の 2 つの方法があります (Command プロパティを持つコントロールでも同様の機能がサポートされます)。

Click イベントの処理
Command プロパティを、コマンドロジックを記述する ICommand 実装にバインドする

XamlUICommand を利用すると、個別のプロパティを設定することなく、アイコン、ラベル、説明、キーボードショートカット (アクセスキーとキーボードアクセラレータの両方) などの UI をコントロールバインドで指定できます。

コンストラクター

XamlUICommand()

XamlUICommand クラスの新しいインスタンスを初期化します。

プロパティ

AccessKey	この要素のアクセスキー (ニーモニック) を取得または設定します。
AccessKeyProperty	AccessKey 依存関係プロパティを識別します。
Command	電子メールの送信、アイテムの削除、フォームの送信など、呼び出されたときにアクションを実行する対話型 UI 要素のコマンド動作を取得または設定します。
CommandProperty	Command 依存関係プロパティを識別します。
Description	この要素の説明を取得または設定します。
DescriptionProperty	Description 依存関係プロパティを識別します。
Dispatcher	このオブジェクトが関連付けられている CoreDispatcher を取得します。 CoreDispatcher は、コードが UI 以外のスレッドによって開始された場合でも、UI スレッド上の DependencyObject にアクセスできる機能を表します。 (継承元 DependencyObject)
IconSource	この要素の Segoe MDL2 Assets フォントからグリフを取得または設定します。
IconSourceProperty	IconSource 依存関係プロパティを識別します。
KeyboardAccelerators	キーボードを使用してアクションを呼び出すこの要素のキーの組み合わせのコレクションを取得または設定します。
KeyboardAcceleratorsProperty	KeyboardAccelerators 依存関係プロパティを識別します。
Label	この要素のラベルを取得または設定します。
LabelProperty	Label 依存関係プロパティを識別します。

メソッド

CanExecute(Object)	コマンドを現在の状態で実行できるかどうかを取得します。
ClearValue(DependencyProperty)	依存関係プロパティのローカル値をクリアします。 (継承元 DependencyObject)
Execute(Object)	コマンドを呼び出します。
GetAnimationBaseValue(DependencyProperty)	依存関係プロパティに対して確立された基本値を返します。これは、アニメーションがアクティブでない場合に適用されます。 (継承元 DependencyObject)
GetValue(DependencyProperty)	DependencyObject から依存関係プロパティの現在の有効な値を返します。 (継承元 DependencyObject)
NotifyCanExecuteChanged()	コマンドの状態が変更されたことをシステムに通知します。
ReadLocalValue(DependencyProperty)	ローカル値が設定されている場合は、依存関係プロパティのローカル値を返します。 (継承元 DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	この DependencyObject インスタンスの特定の DependencyProperty に対する変更をリッスンするための通知関数を登録します。 (継承元 DependencyObject)
SetValue(DependencyProperty, Object)	DependencyObject の依存関係プロパティのローカル値を設定します。 (継承元 DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	RegisterPropertyChangedCallback を呼び出して以前に登録した変更通知を取り消します。 (継承元 DependencyObject)

イベント

CanExecuteChanged	コマンドを実行できるかどうかに影響する何かが発生するたびに発生します。
CanExecuteRequested	CanExecute 呼び出しが行われたときに発生します。
ExecuteRequested	Execute 呼び出しが行われたときに発生します。

適用対象