ExecutableCommandHandler Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Commands

Assembly:: Microsoft.VisualStudio.Extensibility.dll

Package:: Microsoft.VisualStudio.Extensibility v17.12.2051

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 a framework implementation of a command that can be executed.

public abstract class ExecutableCommandHandler : Microsoft.VisualStudio.Extensibility.Commands.PlaceholderCommand, Microsoft.VisualStudio.Extensibility.Commands.IExecutableCommand, System.ComponentModel.INotifyPropertyChanged

type ExecutableCommandHandler = class
    inherit PlaceholderCommand
    interface IExecutableCommand
    interface ICommand
    interface INotifyPropertyChanged

Public MustInherit Class ExecutableCommandHandler
Inherits PlaceholderCommand
Implements IExecutableCommand, INotifyPropertyChanged

Inheritance: Object

PlaceholderCommand
ExecutableCommandHandler

Derived: Microsoft.VisualStudio.Extensibility.Commands.Command

Microsoft.VisualStudio.Extensibility.Commands.DynamicCommand

Implements: ICommand IExecutableCommand INotifyPropertyChanged

Constructors

ExecutableCommandHandler(VisualStudioExtensibility, String)

Initializes a new instance of the ExecutableCommandHandler class.

Properties

DisableDuringExecution	Gets or sets a value indicating whether command should be disabled when it is executing to avoid multiple invocations at the same time.
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.
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	Gets a value indicating whether this instance has been disposed. (Inherited from PlaceholderCommand)
IsEnabled	Gets a value indicating whether this command is enabled or disabled.
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.
ExecuteCommandAsync(IReadOnlyDictionary<String,Object>, CancellationToken)	Called to invoke the command.
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.
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

Partilhar via