CommandOptions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Optional configuration for resource commands added with WithCommand<T>(IResourceBuilder<T>, String, String, Func<ExecuteCommandContext,Task<ExecuteCommandResult>>, CommandOptions).
public class CommandOptionstype CommandOptions = classPublic Class CommandOptions- Inheritance
-
CommandOptions
- Derived
Constructors
| CommandOptions() |
Properties
| ConfirmationMessage |
When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog and the confirmation message before starting the command. |
| Description |
Optional description of the command, to be shown in the UI. Could be used as a tooltip. May be localized. |
| IconName |
The icon name for the command. The name should be a valid FluentUI icon name from https://aka.ms/fluentui-system-icons. |
| IconVariant |
The icon variant. |
| IsHighlighted |
A flag indicating whether the command is highlighted in the UI. |
| Parameter |
Optional parameter that configures the command in some way. Clients must return any value provided by the server when invoking the command. |
| UpdateState |
A callback that is used to update the command state. The callback is executed when the command's resource snapshot is updated. If a callback isn't specified, the command is always enabled. |