Command Interface

Represents a command in the environment.

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

Syntax

'Declaration
<GuidAttribute("5FE10FB0-91A1-4E55-BAAA-ECCAE5CCEB94")> _
Public Interface Command

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

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

[<GuidAttribute("5FE10FB0-91A1-4E55-BAAA-ECCAE5CCEB94")>]
type Command =  interface end

public interface Command

The Command type exposes the following members.

Properties

	Name	Description
	Bindings	Sets or gets the list of keystrokes used to invoke the command.
	Collection	Gets the Commands collection containing the Command object.
	DTE	Gets the top-level extensibility object.
	Guid	Gets the GUID for the given object.
	ID	Gets the ID within a command group GUID used to represent the command.
	IsAvailable	Gets a value indicating whether or not the Command is currently enabled.
	LocalizedName	Gets the localized name of the command.
	Name	Gets the name of the object.

Top

Methods

	Name	Description
	AddControl	Creates a persistent command bar control for the command.
	Delete	Removes a named command that was created with the AddNamedCommand method.

Top

Remarks

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.

Examples

' Macro code.
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

See Also

Reference

EnvDTE Namespace