Condividi tramite

Metodo Commands.AddCommandBar

  • Articolo

Crea una barra dei comandi che viene salvata e resa disponibile al successivo avvio dell'ambiente.

Spazio dei nomi:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Sintassi

'Dichiarazione
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

Parametri

  • Name
    Tipo: System.String
    Obbligatorio.Nome per la nuova barra dei comandi.
  • Position
    Tipo: System.Int32
    Facoltativo.La posizione dell'indice, a partire da 1, nella barra dei comandi in cui deve essere posizionata la nuova barra dei comandi.

Valore restituito

Tipo: System.Object
Un oggetto CommandBar.

Note

L'oggetto CommandBar è un membro del modello a oggetti di Microsoft Office.

La barra dei comandi aggiunta utilizzando questo metodo è una barra dei comandi permanente, disponibile in ogni sessione dell'IDE, indipendentemente dal fatto che il componente aggiuntivo venga caricato. È consigliabile utilizzare questo metodo per aggiungere una barra dei comandi solo se si desidera una barra dei comandi permanente. È necessario chiamare questo metodo solo una volta, quando il componente aggiuntivo viene caricato per la prima volta. Se si desidera una barra dei comandi temporanea, visualizzata solo quando il componente aggiuntivo viene effettivamente caricato, è necessario utilizzare il metodo DTE.CommandBars.Add durante il caricamento del componente aggiuntivo e quindi chiamare il metodo DTE.CommandBars.Remove quando si scarica il componente aggiuntivo.

Poiché una barra dei comandi permanente viene visualizzata anche quando il componente aggiuntivo non è stato caricato, è opportuno accertarsi di rimuoverla quando il componente aggiuntivo viene disinstallato. Di conseguenza, è necessario utilizzare un file MSI per installare e disinstallare il componente aggiuntivo e aggiungere un'azione personalizzata al programma di disinstallazione.

Per ulteriori informazioni sull'aggiunta e la rimozione delle barre dei comandi permanenti e temporanee, vedere HOWTO: Adding buttons, commandbars and toolbars to Visual Studio .NET from an add-in e HOWTO: Removing commands and UI elements during Visual Studio .NET add-in uninstallation.

Esempi

' 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

Sicurezza di .NET Framework

Vedere anche

Riferimenti

Commands Interfaccia

Spazio dei nomi EnvDTE