Sdílet prostřednictvím

Commands2.AddNamedCommand – metoda (AddIn, String, String, String, Boolean, Int32, array<Object %, Int32)

  • Článek

Vytvoří pojmenované příkaz, který je uložen na životní prostředí a k dispozici při příští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ů:  EnvDTE80
Sestavení:  EnvDTE80 (v EnvDTE80.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 nového příkazu.AddNamedCommandprefaces to s "Addins.Progid". vytvořit jedinečný název.
  • ButtonText
    Typ: System.String
    Povinné.Název použít příkaz je vázán na tlačítko, které se zobrazí název spíše ikonou.
  • Tooltip
    Typ: System.String
    Povinné.Text zobrazí, když uživatel ukazatel ukazatel myši všechny ovládací prvky vázané na příkaz Nový.
  • MSOButton
    Typ: System.Boolean
    Povinné.Označuje, zda je obrázek tlačítka pojmenovaná příkaz 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 není prostředek ikonu) Visual C++ resource DLL, která musí být umístěny ve složce s identifikátor národního prostředí tohoto jazyka (1033 pro anglicky). Informace o získání bitmapy hodnot ID MSO tlačítek viz výpis čelí tlačítka na panelu příkazů pro systém Microsoft Office.
  • Bitmap
    Typ: System.Int32
    Nepovinné.ID bitmapy na tlačítko zobrazit.
  • ContextUIGUIDs
    Typ: array<System.Object[]%
    Nepovinné.Pole SafeArray z GUID určující příkaz Zobrazit které kontexty prostředí (to znamená režimu ladění, režim návrhu a podobně).Viz téma vsCommandDisabledFlags.

Vrácená hodnota

Typ: EnvDTE.Command
A Command objektu.

Implementuje

Commands.AddNamedCommand(AddIn, String, String, String, Boolean, Int32, array<Object[]%, Int32)

Poznámky

Doplňky můžete později změnit ButtonText odpovědi na název QueryStatus metody. Pokud text začíná #, zbytek řetězce je celé číslo představující čí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 metody. Pokud ContextUIGUIDs je prázdný, a potom příkaz povolen, dokud doplněk načten a může reagovat na QueryStatus.

Tohoto doplňku můžete obdržet oznámení vyvolání až IDTCommandTarget rozhraní. Můžete přidat pomocí tlačítka OnConnection metodu IDTExtensibility2 rozhraní.

Příklady

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é

Odkaz

Commands2 Rozhraní

AddNamedCommand – přetížení

EnvDTE80 – obor názvů