Command Interface

 

Represents a command in the environment.

Namespace:   EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

[GuidAttribute("5FE10FB0-91A1-4E55-BAAA-ECCAE5CCEB94")]
public interface Command

NameDescription
System_CAPS_pubpropertyBindings

Sets or gets the list of keystrokes used to invoke the command.

System_CAPS_pubpropertyCollection

Gets the Commands collection containing the Command object.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyGuid

Gets the GUID for the given object.

System_CAPS_pubpropertyID

Gets the ID within a command group GUID used to represent the command.

System_CAPS_pubpropertyIsAvailable

Gets a value indicating whether or not the Command is currently enabled.

System_CAPS_pubpropertyLocalizedName

Gets the localized name of the command.

System_CAPS_pubpropertyName

Gets the name of the object.

NameDescription
System_CAPS_pubmethodAddControl(Object, Int32)

Creates a persistent command bar control for the command.

System_CAPS_pubmethodDelete()

Removes a named command that was created with the AddNamedCommand method.

Reference this object by using Item.

You can reference this object a number of ways, such as by using the canonical name or the GUID ID. The easiest way to invoke most commands is by using ExecuteCommand. You can use Raise for the rare instances when you must invoke a command without a name.

Sub CommandExample()
  ' Creates a text document listing all command names.
  Dim Cmd As Command
  Dim Doc As Document
  Dim TxtDoc As TextDocument

  ' Create a new text document.
  DTE.ItemOperations.NewFile ("General\Text File")
  Set Doc = ActiveDocument
  Set TxtDoc = Doc.Object("TextDocument")
  For Each Cmd In Commands
  If (Cmd.Name <> "") Then
    TxtDoc.Selection.Text = Cmd.Name & vbLF
    TxtDoc.Selection.Collapse
  End If
  Next
End Sub
Return to top
Show: