Share via

CommandState Struct

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Commanding
Assembly:
Microsoft.VisualStudio.Text.UI.dll
Package:
Microsoft.VisualStudio.Text.UI v17.9.187

Returned by GetCommandState(T) and determines the state of the command.

public value class CommandState
public struct CommandState
type CommandState = struct
Public Structure CommandState
Inheritance
ValueType
CommandState

Constructors

CommandState(Boolean, Boolean, Boolean, Boolean, Boolean, String)
CommandState(Boolean, Boolean, Boolean, Boolean, String)
CommandState(Boolean, Boolean, String, Boolean)

Properties

Available

A helper singleton representing an available (supported, enabled and visible) command state.
DisplayText

If specified, returns the custom text that should be displayed in the UI.
IsAvailable

If true, the command should be available for execution. IsEnabled and IsVisible properties control how the command should be represented in the UI.
IsChecked

If true, the command should appear as checked (i.e. toggled) in the UI.
IsEnabled

If true, the command should be enabled in the UI.
IsUnspecified

If true, the command state is unspecified and should not be taken into account.
IsVisible

If true, the command should be visible in the UI.
Unavailable

A helper singleton representing an unavailable command state.
Unspecified

A helper singleton representing an unspecified command state.

Applies to