Commands Interface

 

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

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

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

NameDescription
System_CAPS_pubpropertyCount

Gets a value indicating the number of objects in the Commands collection.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a Commands collection.

NameDescription
System_CAPS_pubmethodAdd(String^, Int32, Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Only.

System_CAPS_pubmethodAddCommandBar(String^, vsCommandBarType, Object^, Int32)

Creates a command bar that is saved and available the next time the environment is started.

System_CAPS_pubmethodAddNamedCommand(AddIn^, String^, String^, String^, Boolean, Int32, array<Object^>^, Int32)

Creates a named command that is saved by the environment and made available the next time the environment starts, even if the VSPackage is not loaded on environment startup.

Add-ins are now deprecated. For more information, see FAQ: Converting Add-ins to VSPackage Extensions.

System_CAPS_pubmethodCommandInfo(Object^, String^, Int32)

Returns the command GUID and ID associated with the given Microsoft.VisualStudio.CommandBars.CommandBar control.

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator for items in the Commands collection.

System_CAPS_pubmethodItem(Object^, Int32)

Returns the indexed Command object.

System_CAPS_pubmethodRaise(String^, Int32, Object^, Object^)

Executes the specified command.

System_CAPS_pubmethodRemoveCommandBar(Object^)

Removes a command bar that was created with the AddCommandBar method.

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
Return to top
Show: