定義
命名空間： Microsoft.CommandPalette.Extensions.Toolkit
指示命令面板在執行命令後應執行的作。 這允許命令控制調色板的流。
CommandResult 類用於指定命令面板中命令執行的結果。 它提供了各種方法來控制命令執行后 Command Palette 的行為。 此類可用於管理導航、顯示消息和控制 Command Palette 的狀態。
性能
| 房產 | 類型 | 說明 |
|---|---|---|
| 參數 | ICommandResultArgs | 獲取或設置與命令結果關聯的參數。 這可能包括命令結果所需的其他數據。 |
| 仁慈 (if context refers to kindness) | CommandResultKind | 獲取或設置命令的結果。 預設為 CommandResultKind.Dismiss。 |
方法
| 方法 | 說明 |
|---|---|
| 確認 （ConfirmationArgs） | 向使用者顯示確認對話方塊。 |
| 關閉（） | 執行作后關閉命令面板並關閉當前狀態。 在下一次啟動時，命令選擇區會從主頁面開始，並顯示空白查詢。 |
| 返回（） | 導航到上一頁，並保持打開狀態。 |
| 回家（） | 導航回 Command Palette 的主頁並保持打開狀態。 這將清除當前的頁面堆疊，但保持調色板打開。 |
| 到頁面 （GoToPageArgs） | 導航到調色板中的其他頁面。 GoToPageArgs 將指定要導航到的頁面。 |
| 隱藏（） | 創建一個新的 CommandResult 實例，其中 Kind 設置為 CommandResultKind.Hide，Args 設置為 null。 |
| 保持開啟（） | 不執行任何動作。 這將使調色板保持其當前狀態，以及當前頁面堆疊和查詢。 |
| ShowToast（字符串） | 向用戶顯示臨時桌面級消息。 創建一個新的 CommandResult ，其中 Args 設置為新的 ToastArgs 物件，並將其 Message 設置為 String。 |
| ShowToast （ToastArgs） | 向用戶顯示臨時桌面級消息。 創建一個 Args 設置為 ToastArgs 的新 CommandResult 實例。 |
範例
有關如何使用此功能的示例，請參閱 Command Results 。
