Sdílet prostřednictvím

Commands.AddNamedCommand – metoda

  • Článek

Vytvoří pojmenované příkaz, který je uložen v prostředí a k dispozici při příštím spuštění prostředí, i když 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 Objektu je přidání nového příkazu.
  • Name
    Typ: System.String
    Povinné.Krátký formulář název pro nový příkaz. AddNamedCommand používá předmluvě Addins.Progid. vytvořit jedinečný název.
  • ButtonText
    Typ: System.String
    Povinné.Název, který chcete použít, pokud příkaz je vázán na tlačítko, které se zobrazí název spíše ikonou.
  • Tooltip
    Typ: System.String
    Povinné.Text zobrazený při nastavení ukazatele myši ukazatel všechny ovládací prvky vázané na nový příkaz.
  • MSOButton
    Typ: System.Boolean
    Povinné.Označuje, zda je obrázek s názvem příkazu tlačítko Office obrázku. True tlačítko =.Pokud MSOButton je False, pak Bitmap je ID zdroje rastrový obrázek 16 x 16 (ale není prostředek ikonu) v prostředku Visual C++ knihovny DLL, která musí být umístěny ve složce s identifikátor národního prostředí tohoto jazyka (1033 pro anglicky).
  • Bitmap
    Typ: System.Int32
    Nepovinné.ID bitmapy na tlačítko zobrazit.
  • ContextUIGUIDs
    Typ: array<System.Object[]%
    Nepovinné.Pole SafeArray z GUID určující, které kontexty prostředí (je režim ladění, režim návrhu a podobně) příkaz zobrazit.See vsCommandDisabledFlags..

Vrácená hodnota

Typ: EnvDTE.Command
Objekt Command.

Poznámky

Doplňky můžete později změnit ButtonText podle reagovat na název QueryStatus metoda.Pokud text začíná "#", zbytek řetězce je celé číslo, které představuje číslo ID zdroje v doplňku společnosti registrované satelitní knihovny DLL.

ContextUIGUIDs Parametr a vsCommandStatusValue parametr se používají, když doplněk není načten a nemůže tedy reagovat na QueryStatus metoda.Pokud ContextUIGUIDs je prázdný, a potom příkaz povolen, dokud doplněk je 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 metodu 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

Viz také

Referenční dokumentace

Commands Rozhraní

EnvDTE – obor názvů