Commands Interface

Contains all of the commands in the environment, as Command objects.

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

Syntax

'Declaration
<GuidAttribute("E6B96CAC-B8C7-40AE-B705-5C81878C4A9E")> _
Public Interface Commands _
    Inherits IEnumerable

[GuidAttribute("E6B96CAC-B8C7-40AE-B705-5C81878C4A9E")]
public interface Commands : IEnumerable

[GuidAttribute(L"E6B96CAC-B8C7-40AE-B705-5C81878C4A9E")]
public interface class Commands : IEnumerable

[<GuidAttribute("E6B96CAC-B8C7-40AE-B705-5C81878C4A9E")>]
type Commands =  
    interface 
        interface IEnumerable 
    end

public interface Commands extends IEnumerable

The Commands type exposes the following members.

Properties

	Name	Description
	Count	Gets a value indicating the number of objects in the Commands collection.
	DTE	Gets the top-level extensibility object.
	Parent	Gets the immediate parent object of a Commands collection.

Top

Methods

	Name	Description
	Add	Infrastructure. Microsoft Internal Only.
	AddCommandBar	Creates a command bar that is saved and available the next time the environment is started.
	AddNamedCommand	Creates a named command that is saved by the environment and made available the next time the environment starts, even if the Add-in is not loaded on environment startup.
	CommandInfo	Returns the command GUID and ID associated with the given Microsoft.VisualStudio.CommandBars.CommandBar control.
	GetEnumerator	Returns an enumerator for items in the Commands collection.
	Item	Returns the indexed Command object.
	Raise	Executes the specified command.
	RemoveCommandBar	Removes a command bar that was created with the AddCommandBar method.

Top

Examples

Imports Microsoft.VisualStudio.CommandBars
Sub CommandsExample()
   ' Before running, you must add a reference to the Office 
   ' typelib to gain access to the CommandBar object.
   Dim cmds As Commands
   Dim cmdobj As Command
   Dim customin, customout As Object
   Dim cmdbarobj As CommandBar
   Dim colAddins As AddIns

   ' Set references.
   colAddins = DTE.AddIns()
   cmds = DTE.Commands
   cmdobj = cmds.Item("File.NewFile")

   ' Execute the File.NewFile command.
   cmds.Raise(cmdobj.Guid, cmdobj.ID, customin, customout)

   ' Create a toolbar and add the File.NewFile command to it.
   cmdobj = cmds.Item("File.NewFile")
   cmdbarobj = cmds.AddCommandBar("Mycmdbar", _
     vsCommandBarType.vsCommandBarTypeToolbar)
   cmdobj.AddControl(cmdbarobj)
   ' Show the command bar and its button.
   cmdbarobj.Visible = True
End Sub

See Also

Reference

EnvDTE Namespace