Sdílet prostřednictvím

Commands.AddCommandBar – metoda

  • Článek

Vytvoří panel příkazů, která je uložena a budou k dispozici při příštím spuštění prostředí.

Obor názvů:  EnvDTE
Sestavení:  EnvDTE (v EnvDTE.dll)

Syntaxe

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

Parametry

  • Name
    Typ: String

    Povinné.Název pro nový panel příkazů.

  • CommandBarParent
    Typ: Object

    Volitelné.Úřední CommandBar objekt, na který má být přidán nový panel příkazů. (To je nutné, ale pokud Type je vsCommandBarTypeMenu.)

  • Position
    Typ: Int32

    Volitelné.Pozice indexu počínaje číslem jedna v panelu příkazů, který chcete umístit nový panel příkazů.

Vrácená hodnota

Typ: Object
Objekt CommandBar.

Poznámky

CommandBar Je objekt člena objektového modelu aplikace Microsoft Office.

Panel příkazů, které jsou přidány pomocí této metody je trvalý příkaz panel, který je k dispozici v každé relaci rozhraní IDE, zda doplněk je zaveden.Tuto metodu používejte pouze v případě, že má trvalý příkaz panel Přidat panel příkazů.Tato metoda by měla volat pouze jednou, když doplněk je načten jako první.Pokud chcete, aby dočasný příkaz panel, který se zobrazí, pouze pokud doplněk je skutečně načten, je nutné použít DTE.CommandBars.Add metoda při načtení doplňku aplikace a poté zavolejte DTE.CommandBars.Remove metoda po odinstalování doplňku.

Protože trvalý příkaz panel se zobrazí i při doplněk není načten, je třeba ji odstranit po odinstalaci doplňku.Proto musí nainstalovat a odinstalovat doplněk pomocí technologie MSI a přidat vlastní akci do programu odinstalovat.

Další informace o přidávání a odebírání panely příkazů trvalé a dočasné, viz Postupy: Přidání commandbars tlačítka a panely nástrojů aplikace Visual Studio .NET-in a Postupy: odstranění příkazů a prvky uživatelského rozhraní během odinstalování doplňku aplikace Visual Studio .NET.

Příklady

' 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

Zabezpečení rozhraní .NET Framework

Viz také

Referenční dokumentace

Commands Rozhraní

EnvDTE – obor názvů