定義
名前空間: Microsoft.CommandPalette.Extensions.Toolkit
コマンドの実行後にコマンド パレットが何をすべきかを示します。 これにより、コマンドでパレットのフローを制御できます。
ICommandResult を実装します
CommandResult クラスは、コマンド パレットでコマンドの実行結果を指定するために使用されます。 コマンドの実行後のコマンド パレットの動作を制御するためのさまざまな方法が用意されています。 このクラスは、ナビゲーションの管理、メッセージの表示、およびコマンド パレットの状態の制御に役立ちます。
特性
| プロパティ | タイプ | 説明 |
|---|---|---|
| 引数 | ICommandResultArgs | コマンドの結果に関連付けられている引数を取得または設定します。 これには、コマンドの結果に必要な追加データが含まれる場合があります。 |
| 優しい | CommandResultKind(コマンド結果の種類) | コマンドの結果を取得または設定します。 既定値は CommandResultKind.Dismiss です。 |
メソッド
| メソッド | 説明 |
|---|---|
| 確認(ConfirmationArgs) | ユーザーに確認ダイアログを表示します。 |
| 却下() | アクションの実行後にコマンド パレットを閉じ、現在の状態を閉じます。 次の起動時に、コマンド パレットはメイン ページから空のクエリで開始されます。 |
| 戻る() | 前のページに移動し、開いたままにしておきます。 |
| ゴーホーム() | コマンド パレットのメイン ページに戻り、開いたままにします。 これにより、現在のページのスタックがクリアされますが、パレットは開いたままになります。 |
| GoToPage(GoToPageArgs) | パレット内の別のページに移動します。 GoToPageArgs は、移動先のページを指定します。 |
| 隠れる() |
Kind を CommandResultKind.Hide に、Args を に設定した新しい null インスタンスを作成します。 |
| KeepOpen() | 何もしない。 これにより、パレットは現在の状態のままで、現在のページスタックとクエリが表示されます。 |
| ShowToast(文字列) | 一時的なデスクトップ レベルのメッセージをユーザーに表示します。 Args が新しい ToastArgs オブジェクトに設定された新しい CommandResult を作成し、その Message が String に設定された CommandResult を作成します。 |
| ShowToast(トーストアーグス) | 一時的なデスクトップ レベルのメッセージをユーザーに表示します。 Args を ToastArgs に設定した新しい CommandResult インスタンスを作成します。 |
例
これの使用方法の例については、「 コマンド結果 」を参照してください。
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Windows developer