CommandSetLibrary Class

Article
11/24/2013

Base class for CommandSet and ClipboardCommandSet. Provides access to current selection, diagram, windows and services.

This API is not CLS-compliant.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    Microsoft.VisualStudio.Modeling.Shell.CommandSetLibrary
      Microsoft.VisualStudio.Modeling.Shell.ClipboardCommandSet
      Microsoft.VisualStudio.Modeling.Shell.CommandSet

Namespace: Microsoft.VisualStudio.Modeling.Shell
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class CommandSetLibrary _
    Inherits MarshalByRefObject

[CLSCompliantAttribute(false)]
public abstract class CommandSetLibrary : MarshalByRefObject

[CLSCompliantAttribute(false)]
public ref class CommandSetLibrary abstract : public MarshalByRefObject

[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type CommandSetLibrary =  
    class 
        inherit MarshalByRefObject 
    end

public abstract class CommandSetLibrary extends MarshalByRefObject

The CommandSetLibrary type exposes the following members.

Constructors

	Name	Description
	CommandSetLibrary	Creates a new CommandSetLibrary.

Top

Properties

	Name	Description
	CurrentDocData
	CurrentDocumentSelection
	CurrentModelingDocView
	CurrentSelection
	MenuService
	MonitorSelection
	ServiceProvider
	SingleDocumentSelection
	SingleSelection

Top

Methods

	Name	Description
	CanDeleteSelectedItems	Returns true if the selected items can be deleted.
	CreateObjRef	Security Critical. Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	DeleteSelectedItems	Delete the selected items.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLifetimeService	Security Critical. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetMenuCommands	Defines the list of menu commands that this CommandSet implements.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	Initialize the command set. Calls GetMenuCommands and caches the result.
	InitializeLifetimeService	Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	IsAnyDocumentSelectionCompartment	True if any of the items in the selection list is a compartment.
	IsAnyDocumentSelectionMoveableHostShape	True if any of the items in the selection list is a moveable host shape, which cannot be deleted.
	IsAnyDocumentSelectionUndeletable	True if any of the shape items in the selection list cannot be deleted.
	IsCurrentDiagramEmpty	True if the diagram has no children.
	IsDiagramSelected	True if the diagram is selected.
	IsSingleDocumentSelection	True if there is only one selected item on the active document.
	IsSingleSelection	True if there is only one selected item on the active document window or tool window.
	MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

For more information, see How to: Add a Command to the Shortcut Menu.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via