定义
命名空间： Microsoft.CommandPalette.Extensions.Toolkit
指示命令面板在执行命令后应执行的作。 这允许命令控制调色板的流。
CommandResult 类用于指定命令面板中命令执行的结果。 它提供了各种方法来控制命令执行后 Command Palette 的行为。 此类可用于管理导航、显示消息和控制 Command Palette 的状态。
性能
| 资产 | 类型 | DESCRIPTION |
|---|---|---|
| 参数 | ICommandResultArgs | 获取或设置与命令结果关联的参数。 这可能包括命令结果所需的其他数据。 |
| 种类 | CommandResultKind | 获取或设置命令的结果。 默认为 CommandResultKind.Dismiss。 |
方法
| 方法 | DESCRIPTION |
|---|---|
| 确认 （ConfirmationArgs） | 向用户显示确认对话框。 |
| 关闭（） | 执行作后关闭命令面板并关闭当前状态。 在下一次启动时，命令面板将从主页开始，其中包含空白查询。 |
| 返回（） | 导航到上一页，并保持打开状态。 |
| 回家（） | 导航回 Command Palette 的主页并保持打开状态。 这将清除当前的页面堆栈，但保持调色板打开。 |
| 转到页面 （GoToPageArgs） | 导航到调色板中的其他页面。 GoToPageArgs 将指定要导航到的页面。 |
| 隐藏（） | 创建一个新的 CommandResult 实例，其中 Kind 设置为 CommandResultKind.Hide，Args 设置为 null。 |
| 保持打开（） | 什么都不做。 这将使调色板保持其当前状态，以及当前页面堆栈和查询。 |
| ShowToast（字符串） | 向用户显示临时桌面级消息。 创建一个新的 CommandResult ，其中 Args 设置为新的 ToastArgs 对象，并将其 Message 设置为 String。 |
| ShowToast （ToastArgs） | 向用户显示临时桌面级消息。 创建一个 Args 设置为 ToastArgs 的新 CommandResult 实例。 |
示例：
有关如何使用此功能的示例，请参阅 Command Results 。
