Commands.AddCommandBar-Methode

Erstellt eine Befehlsleiste, die gespeichert und beim nächsten Start der Umgebung bereitgestellt wird.

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

Syntax

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

Parameter

• Name
  Typ: String

  Erforderlich. Ein Name für die neue Befehlsleiste.

• Type
  Typ: EnvDTE.vsCommandBarType

  Erforderlich. Eine vsCommandBarType-Konstante, die den Befehlsleistentyp bestimmt:

• CommandBarParent
  Typ: Object

  Optional. Ein CommandBar-Objekt von Office, dem die neue Befehlsleiste hinzugefügt werden soll. (Dieser Parameter ist jedoch erforderlich, wenn Type vsCommandBarTypeMenu ist.)

• Position
  Typ: Int32

  Optional. Die Indexposition auf der Befehlsleiste (beginnend bei Eins), an der die neue Befehlsleiste eingefügt werden soll.

Rückgabewert

Typ: Object
Ein CommandBar-Objekt.

Hinweise

Das CommandBar-Objekt ist ein Member des Microsoft Office-Objektmodells.

Die Befehlsleiste, die mit dieser Methode hinzugefügt wurde, ist eine permanente Befehlsleiste, die in jeder Sitzung in der IDE verfügbar ist, unabhängig davon, ob das Add-In geladen wird. Sie sollten diese Methode nur verwenden, um eine Befehlsleiste hinzuzufügen, wenn Sie eine permanente Befehlsleiste möchten. Sie sollten diese Methode nur einmal aufrufen, wenn das Add-In zum ersten Mal geladen wird. Wenn Sie eine temporäre Befehlsleiste möchten, die nur beim tatsächlichen Laden des Add-Ins angezeigt wird, müssen Sie die DTE.CommandBars.Add-Methode verwenden, wenn Sie das Add-In laden, und anschließend die DTE.CommandBars.Remove-Methode aufrufen, wenn Sie das Add-In entladen.

Da eine permanente Befehlsleiste angezeigt, selbst wenn das Add-In nicht geladen wird, sollten Sie diese unbedingt entfernen, wenn das Add-In deinstalliert wird. Daher müssen Sie eine MSI verwenden, um das Add-In zu installieren und zu deinstallieren, und dem Deinstallationsprogramm eine benutzerdefinierte Aktion hinzufügen.

Weitere Informationen zum Hinzufügen und Entfernen von permanenten und temporären Befehlsleisten finden Sie unter SO WIRD'S GEMACHT: Hinzufügen von Schaltflächen, Befehlsleisten und Symbolleisten zu Visual Studio .NET aus einem Add-In und SO WIRD'S GEMACHT: Entfernen von Befehlen und UI-Elementen während der Visual Studio .NET-Add-In-Deinstallation.

Beispiele

' 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

.NET Framework-Sicherheit

• Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

Commands Schnittstelle

EnvDTE-Namespace