CommandSetLibrary Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Shell

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Shell.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Shell.dll

Package:: Microsoft.VisualStudio.Modeling.Sdk.Shell v17.10.40171

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.

Important

This API is not CLS-compliant.

Base class for command classes interacts with visual studio commands. Contains DocData, DocView and selection related properties.

public ref class CommandSetLibrary abstract : MarshalByRefObject

[System.CLSCompliant(false)]
public abstract class CommandSetLibrary : MarshalByRefObject

public abstract class CommandSetLibrary : MarshalByRefObject

[<System.CLSCompliant(false)>]
type CommandSetLibrary = class
    inherit MarshalByRefObject

type CommandSetLibrary = class
    inherit MarshalByRefObject

Public MustInherit Class CommandSetLibrary
Inherits MarshalByRefObject

Inheritance: MarshalByRefObject
CommandSetLibrary

Derived: Microsoft.VisualStudio.Modeling.Shell.ClipboardCommandSet

Microsoft.VisualStudio.Modeling.Shell.CommandSet

Attributes: CLSCompliantAttribute

Constructors

CommandSetLibrary(IServiceProvider)

Creates a new CommandSet

Properties

CurrentDocData	Currently focused document
CurrentDocumentSelection	Returns the collection of selected elements in the active document window.
CurrentModelingDocView	Currently focused document view
CurrentSelection	Returns the collection of selected elements in the active window. This could be a document window or tool window.
MenuService	Menu command service used to manage command handlers.
MonitorSelection	Service used to track selection in the Visual Studio shell.
ServiceProvider	Service provider used to retrieve Visual Studio services.
SingleDocumentSelection	Returns the primary selected object in the active document window.
SingleSelection	Returns the primary selected object in active window. This could be a document window or tool window.

Methods

CanDeleteSelectedItems()	Determine whether selected item can be deleted or not
DeleteSelectedItems(String)	Protected method to delete selected items
GetMenuCommands()	Provide the menu commands that this commandset implements
Initialize()	Initialize the command set
InitializeAsync(CancellationToken)
IsAnyDocumentSelectionCompartment()	Returns whether any of the items in the selection list is a compartment.
IsAnyDocumentSelectionMoveableHostShape()	Returns whether any of the items in the selection list is a moveable host shape, which cannot be deleted.
IsAnyDocumentSelectionUndeletable()	Returns whether any of the shape items in the selection list cannot be deleted. Base implementation checks for Compartment and MoveableHostShape shapes.
IsCurrentDiagramEmpty()	Returns true if diagram has no children.
IsDiagramSelected()
IsSingleDocumentSelection()	Returns whether or not there is only one selected item on the active document.
IsSingleSelection()	Returns whether or not there is only one selected item on the active window. This could be a document or tool window.

Applies to

Share via