Commands2.AddNamedCommand2 – 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ů: EnvDTE80
Sestavení: EnvDTE80 (v EnvDTE80.dll)

Syntaxe

'Deklarace
Function AddNamedCommand2 ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Object, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandStatusValue As Integer, _
    CommandStyleFlags As Integer, _
    ControlType As vsCommandControlType _
) As Command

Command AddNamedCommand2(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    Object Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandStatusValue,
    int CommandStyleFlags,
    vsCommandControlType ControlType
)

Command^ AddNamedCommand2(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] Object^ Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandStatusValue, 
    [InAttribute] int CommandStyleFlags, 
    [InAttribute] vsCommandControlType ControlType
)

abstract AddNamedCommand2 : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:Object * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandStatusValue:int * 
        CommandStyleFlags:int * 
        ControlType:vsCommandControlType -> Command

function AddNamedCommand2(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : Object, 
    ContextUIGUIDs : Object[], 
    vsCommandStatusValue : int, 
    CommandStyleFlags : int, 
    ControlType : vsCommandControlType
) : Command

Parametry

AddInInstance
Typ: AddIn

Požadováno.AddIn Přidává nový příkaz.

Name
Typ: String

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

ButtonText
Typ: String

Požadováno.Název zobrazit v uživatelském rozhraní pro tento příkaz.

Tooltip
Typ: String

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

MSOButton
Typ: Boolean

Požadováno.Must be false.

Bitmap
Typ: Object

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

Bitmap může být jeden z následujících:

-ABitmap

-KIcon

-IPicture

-ID prostředku rastrový obrázek 16 x 16 (ale nikoli prostředek s ikonou) uvedenou v doplňku.Visual Studio vyhledá první v doplňku na satelitní knihovny DLL.Pokud prostředek není nalezen zde, budou prohledány knihovnu DLL.

ContextUIGUIDs
Typ: array<Object[]%

Volitelné.Identifikátory GUID, které určují, které kontexty prostředí (to znamená, že režim ladění, návrhovém režimu atd.) příkaz zobrazit.

vsCommandStatusValue
Typ: Int32

Volitelné.Určuje, zda je zakázaném stavu příkazu neviditelný nebo zakázaný při zadání ContextUIGUIDs parametr a žádné je právě aktivní.Viz téma vsCommandDisabledFlags.

CommandStyleFlags
Typ: Int32

Volitelné.One of the vsCommandStyle flags, in particular vsCommandStylePict, vsCommandStylePictAndText, or vsCommandStyleText.

ControlType
Typ: EnvDTE80.vsCommandControlType

Volitelné.Určuje typ ovládacího prvku, který je přidán při vytvoření uživatelského rozhraní.

Vrácená hodnota

Typ: Command
Pojmenovaný příkaz, který byl vytvořen.

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.

Existují dva stavy výchozí příkaz: ve výchozím nastavení povolen stav a výchozí stav viditelnosti.Tyto výchozí stavy jsou důležité, pokud nelze najít příkaz popisovač (protože komponenta není načten nebo neimplementuje IDTCommandTarget).Pokud vaše komponenta je načten a implementuje IDTCommandTarget, nikdy použít výchozí hodnoty.

Existují dva zajímavé případy použití výchozí státy:

Poskytování uživatelského rozhraní GUID kontextu prostřednictvím ContextUIGUIDs parametr.V tomto případě je viditelnost zcela určena GUID zadaný kontext.Pokud kontextu je aktivní, pak je příkaz viditelný, jinak je skrytý.Stav povoleno je zcela určen výchozí hodnoty.Ve výchozím nastavení v aplikaci Visual Studio na příkaz vždy povolena Pokud předáte vsCommandDisabledFlagsGrey pak bude výchozím stavu zakázán.Pokud předáte vsCommandDisabledFlagsEnabled nebo jednoduše nezadáte tento parametr, je povoleno výchozí stav.
GUID uživatelského kontextu prostřednictvím neposkytují ContextUIGUIDs parametr.V tomto případě viditelnosti je založen na příznaky, které předat vsCommandStatusValue nebo výchozího stavu.Výchozí příkaz viditelnost ve VS je viditelná.Pokud předáte vsCommandDisabledFlagsHidden, výchozí hodnota je neviditelný.Stav povoleno je zde stejný jako v případě výše 1 (podle příznaků nebo výchozí chování VS).

Tohoto doplňku můžete obdržet oznámení vyvolání až IDTCommandTarget rozhraní.Tlačítko můžete přidat pomocí OnConnection metoda IDTExtensibility2 rozhraní.

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

Commands2 Rozhraní

EnvDTE80 – obor názvů

Sdílet prostřednictvím