Commands.AddNamedCommand – metoda

Článek
05/16/2015

Vytvoří pojmenované příkaz, který je uložil na životní prostředí a k dispozici při dalším spuštění prostředí i v případě, že doplněk není načten při spuštění prostředí.

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

Syntaxe

'Deklarace
Function AddNamedCommand ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Integer, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandDisabledFlagsValue As Integer _
) As Command

Command AddNamedCommand(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    int Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandDisabledFlagsValue
)

Command^ AddNamedCommand(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] int Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandDisabledFlagsValue
)

abstract AddNamedCommand : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:int * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandDisabledFlagsValue:int -> Command

function AddNamedCommand(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : int, 
    ContextUIGUIDs : Object[], 
    vsCommandDisabledFlagsValue : int
) : Command

Parametry

AddInInstance
Typ: EnvDTE.AddIn

Povinné.AddIn Objekt je přidání nového příkazu.

Name
Typ: String

Povinné.Zkratka pro název nového příkazu.AddNamedCommandpoužívá předmluvě Addins.Progid. Chcete-li vytvořit jedinečný název.

ButtonText
Typ: String

Povinné.Název pro použití v případě, že příkaz je vázán na ovládací prvek, který je zobrazen podle názvu a nikoli podle ikony.

Tooltip
Typ: String

Povinné.Text zobrazený při nastavení ukazatele myši nad všechny ovládací prvky vázané na nový příkaz.

MSOButton
Typ: Boolean

Povinné.Označuje, zda je pojmenovaný příkaz tlačítko Obrázek Obrázek sady Office.True= tlačítko.Pokud MSOButton je False, pak Bitmap je Identifikátor prostředku rastrový obrázek 16 x 16 (ale nikoli prostředek s ikonou) v Visual C++ resource DLL, která musí být umístěny ve složce pomocí identifikátoru národního prostředí tohoto jazyka (1033 pro angličtinu).

Bitmap
Typ: Int32

Volitelné.ID rastrový obrázek na tlačítku zobrazit.

ContextUIGUIDs
Typ: array<Object[]%

Volitelné.SafeArray z GUID určující příkaz Zobrazit které kontexty prostředí (to znamená, že režim ladění, návrhovém režimu atd.).See vsCommandDisabledFlags..

vsCommandDisabledFlagsValue
Typ: Int32

Vrácená hodnota

Typ: EnvDTE.Command
Objekt Command.

Poznámky

Doplňky lze později změnit ButtonText název odpovědi na QueryStatus metody.Pokud text začíná znakem "#", zbytek řetězce je celé číslo, které představuje ID prostředku v doplňku na registrované satelitní knihovny DLL.

ContextUIGUIDs Parametr a vsCommandStatusValue parametr při doplněk není načten a nemůže tedy reagovat na QueryStatus metody.Pokud ContextUIGUIDs je prázdný, a pak příkaz je povolen, dokud doplněk načten a může reagovat na QueryStatus.

Doplněk můžete obdržet oznámení vyvolání až IDTCommandTarget rozhraní.Tlačítko můžete přidat pomocí OnConnection metoda IDTExtensibility2 rozhraní

Příklady

' Macro code.
Imports Microsoft.VisualStudio.CommandBars
Sub AddControlExample()
   ' 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 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.
   cmds.AddCommandBar("Mycmdbar", _
   vsCommandBarType.vsCommandBarTypeToolbar)
   MsgBox("Commandbar name: " & cmdbarobj.Name)
   cmdobj.AddControl(cmdbarobj)
   cmds.AddNamedCommand(colAddins.Item(1), "MyCommand", _
   "Button Text", "Some tooltip", True)
End Sub

Zabezpečení rozhraní .NET Framework

Plná důvěra přímému volajícímu. Částečně zabezpečený kód nemůže tento člen použít. Další informace naleznete v tématu Používání knihoven z částečně důvěryhodného kódu.

Viz také

Referenční dokumentace

Commands Rozhraní

EnvDTE – obor názvů

Sdílet prostřednictvím