Command Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Commands

Assembly:: Microsoft.VisualStudio.Extensibility.dll

Package:: Microsoft.VisualStudio.Extensibility v17.11.350

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.

Provides functionality for extending Visual Studio through brokered services.

public abstract class Command : Microsoft.VisualStudio.Extensibility.Commands.ExecutableCommandHandler, Microsoft.VisualStudio.Extensibility.IVisualStudioContributionClass

type Command = class
    inherit ExecutableCommandHandler
    interface IVisualStudioContributionClass

Public MustInherit Class Command
Inherits ExecutableCommandHandler
Implements IVisualStudioContributionClass

Inheritance: Object

PlaceholderCommand

ExecutableCommandHandler
Command

Derived: Microsoft.VisualStudio.Extensibility.Commands.ToggleCommand

Implements: IVisualStudioContributionClass

Constructors

Command()	Initializes a new instance of the Command class.
Command(VisualStudioExtensibility)	Initializes a new instance of the Command class.

Properties

CommandConfiguration	Gets the configuration for this command. The value of this property is evaluated at compile time when building the Visual Studio extension.
DisableDuringExecution	Gets or sets a value indicating whether command should be disabled when it is executing to avoid multiple invocations at the same time. (Inherited from ExecutableCommandHandler)
DisplayName	Gets the display name for the command, or `null` if the display name comes from registered metadata. (Inherited from PlaceholderCommand)
Extensibility	Gets the Visual Studio extensibility point. (Inherited from ExecutableCommandHandler)
Flags	Gets the flags associated with the command. (Inherited from PlaceholderCommand)
Id	Gets a unique id for this command within its command set. (Inherited from PlaceholderCommand)
IsDisposed	(Inherited from PlaceholderCommand)
IsEnabled	Gets a value indicating whether this command is enabled or disabled. (Inherited from ExecutableCommandHandler)
IsVisible	Gets a value indicating whether this command is visible or invisible. (Inherited from PlaceholderCommand)
TooltipText	Gets the tooltip text for the command, or the display name if no tooltip text was provided. (Inherited from PlaceholderCommand)

Methods

Dispose()	(Inherited from PlaceholderCommand)
Dispose(Boolean)	Disposes the command instance. (Inherited from PlaceholderCommand)
ExecuteCommandAsync(IClientContext, CancellationToken)	Raised when command is executed on the client. (Inherited from ExecutableCommandHandler)
ExecuteCommandAsync(IReadOnlyDictionary<String,Object>, CancellationToken)	Called to invoke the command. (Inherited from ExecutableCommandHandler)
InitializeAsync(CancellationToken)	Completes async initialization of command instance. (Inherited from PlaceholderCommand)
OnPropertyChanged(PropertyChangedEventArgs)	Fires PropertyChanged event. (Inherited from PlaceholderCommand)
SetEnabledState(Nullable<Boolean>)	Set this command as enabled, disabled, or `null` to determine the enabled state from registered metadata. Setting this value to null will fall back to using the registered metadata context rule if one was provided. (Inherited from ExecutableCommandHandler)
SetVisibilityState(Nullable<Boolean>)	Set this command as visible, invisible, or `null` to determine the visibility state from registered metadata. Setting this value to null will fall back to using the registered metadata context rule if one was provided. (Inherited from PlaceholderCommand)

Events

PropertyChanged

(Inherited from PlaceholderCommand)

Applies to

Share via