Commands2.RemoveCommandBar Method

Article
03/18/2013

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

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

Syntax

'Declaration
Sub RemoveCommandBar ( _
    CommandBar As Object _
)

void RemoveCommandBar(
    Object CommandBar
)

void RemoveCommandBar(
    [InAttribute] Object^ CommandBar
)

abstract RemoveCommandBar : 
        CommandBar:Object -> unit

function RemoveCommandBar(
    CommandBar : Object
)

Parameters

CommandBar
Type: System.Object
Required. The CommandBar object to remove.

Implements

Commands.RemoveCommandBar(Object)

Remarks

This method fails if the command bar is intrinsic (built-in) to the environment.

Examples

Imports Microsoft.VisualStudio.CommandBars
Sub RemoveCommandBarExample()
   ' Before running, you must add a reference to the Office 
   ' typelib to gain access to the CommandBar object. Also, for this 
   ' example to work correctly, there should be an add-in available 
   ' in the Visual Studio environment.
   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")

   ' Create a toolbar and add the File.NewFile command to it.
   cmdbarobj = cmds.AddCommandBar("Mycmdbar", vsCommandBarType.vsCommandBarTypeToolbar)
   MsgBox("Commandbar name: " & cmdbarobj.Name)
   cmdobj.AddControl(cmdbarobj)
   cmds.AddNamedCommand(colAddins.Item(1), "MyCommand", "Button Text", "Some tooltip", True)
   cmds.RemoveCommandBar(cmdbarobj)

End Sub

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.