Commands.AddCommandBar (Método)

Crea una barra de comandos que se guarda y está disponible la próxima vez que se inicia el entorno.

Espacio de nombres:  EnvDTE
Ensamblado:  EnvDTE (en EnvDTE.dll)

Sintaxis

'Declaración
Function AddCommandBar ( _
    Name As String, _
    Type As vsCommandBarType, _
    CommandBarParent As Object, _
    Position As Integer _
) As Object

Object AddCommandBar(
    string Name,
    vsCommandBarType Type,
    Object CommandBarParent,
    int Position
)

Object^ AddCommandBar(
    [InAttribute] String^ Name, 
    [InAttribute] vsCommandBarType Type, 
    [InAttribute] Object^ CommandBarParent, 
    [InAttribute] int Position
)

abstract AddCommandBar : 
        Name:string * 
        Type:vsCommandBarType * 
        CommandBarParent:Object * 
        Position:int -> Object

function AddCommandBar(
    Name : String, 
    Type : vsCommandBarType, 
    CommandBarParent : Object, 
    Position : int
) : Object

Parámetros

• Name
  Tipo: String

  Obligatorio. Nombre de la nueva barra de comandos.

• Type
  Tipo: EnvDTE.vsCommandBarType

  Obligatorio. Constante vsCommandBarType que determina el tipo de la barra de comandos:

• CommandBarParent
  Tipo: Object

  Opcional. Objeto CommandBar de Office al que se agregará la nueva barra de comandos (Sin embargo, es necesario si Type es vsCommandBarTypeMenu).

• Position
  Tipo: Int32

  Opcional. Posición del índice, a partir de uno, en la barra de comandos donde se colocará la nueva barra de comandos.

Valor devuelto

Tipo: Object
Un objeto CommandBar.

Comentarios

El objeto CommandBar es un miembro del modelo de objetos de Microsoft Office.

La barra de comandos que se agrega mediante este método es de tipo permanente, es decir, está disponible en cada sesión del IDE, independientemente de que se cargue o no el complemento. Debe utilizar este método para agregar una barra de comandos únicamente si desea una barra de comandos permanente. Debe llamar a este método sólo una vez, cuando el complemento se carga por primera vez. Si desea usar una barra de comandos temporal, que solo aparece cuando el complemento se carga realmente, debe usar el método DTE.CommandBars.Add al cargar el complemento y, después, llamar al método DTE.CommandBars.Remove cuando desee descargarlo.

Puesto que aparece una barra de comandos permanente aun cuando no está cargado el complemento, deberá asegurarse de quitarla al desinstalar el complemento. Por tanto, debe usar un MSI para instalar y desinstalar el complemento y agregar una acción personalizada al programa de desinstalación.

Para obtener más información sobre agregar y eliminar barras de comandos permanentes y temporales, vea HOWTO: Adding buttons, commandbars and toolbars to Visual Studio .NET from an add-in y HOWTO: Removing commands and UI elements during Visual Studio .NET add-in uninstallation.

Ejemplos

' Macro code.
Imports Microsoft.VisualStudio.CommandBars
Sub AddCommandBarExample()
   ' 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 = cmds.AddNamedCommand(colAddins.Item(1), "mycommand", _
   "mycommand", "tooltip for mycommand", True)
End Sub

Seguridad de .NET Framework

• Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.

Vea también

Referencia

Commands Interfaz

EnvDTE (Espacio de nombres)