Commands2.AddNamedCommand2(AddIn, String, String, String, Boolean, Object, Object[], Int32, Int32, vsCommandControlType) Metoda

Definice

Vytvoří pojmenovaný příkaz, který je uložený v prostředí a zpřístupní se při příštím spuštění prostředí, a to i v případě, že se doplněk nenačte při spuštění prostředí.Creates a named command that is saved by the environment and made available the next time the environment starts, even if the add-in is not loaded on environment startup.

EnvDTE::Command AddNamedCommand2(EnvDTE::AddIn const & AddInInstance, std::wstring const & Name, std::wstring const & ButtonText, std::wstring const & Tooltip, bool MSOButton, winrt::Windows::Foundation::IInspectable const & Bitmap, std::Array <winrt::Windows::Foundation::IInspectable const &> const & & ContextUIGUIDs, int vsCommandStatusValue = 3, int CommandStyleFlags = 3, EnvDTE80::vsCommandControlType ControlType = EnvDTE80.vsCommandControlType.vsCommandControlTypeButton);
[System.Runtime.InteropServices.DispId(20)]
public EnvDTE.Command AddNamedCommand2 (EnvDTE.AddIn AddInInstance, string Name, string ButtonText, string Tooltip, bool MSOButton, object Bitmap, ref object[] ContextUIGUIDs, int vsCommandStatusValue = 3, int CommandStyleFlags = 3, EnvDTE80.vsCommandControlType ControlType = EnvDTE80.vsCommandControlType.vsCommandControlTypeButton);
[<System.Runtime.InteropServices.DispId(20)>]
abstract member AddNamedCommand2 : EnvDTE.AddIn * string * string * string * bool * obj * Object[] * int * int * EnvDTE80.vsCommandControlType -> EnvDTE.Command
Public Function AddNamedCommand2 (AddInInstance As AddIn, Name As String, ButtonText As String, Tooltip As String, MSOButton As Boolean, Optional Bitmap As Object, Optional ByRef ContextUIGUIDs As Object(), Optional vsCommandStatusValue As Integer = 3, Optional CommandStyleFlags As Integer = 3, Optional ControlType As vsCommandControlType = EnvDTE80.vsCommandControlType.vsCommandControlTypeButton) As Command

Parametry

AddInInstance
AddIn

Povinná hodnota.Required. AddInPřidání nového příkazu.The AddIn that is adding the new command.

Name
String

Povinná hodnota.Required. Krátký tvar názvu nového příkazu.The short form of the name for your new command. AddNamedCommand2(AddIn, String, String, String, Boolean, Object, Object[], Int32, Int32, vsCommandControlType) používá modul AddIns. ProgID.AddNamedCommand2(AddIn, String, String, String, Boolean, Object, Object[], Int32, Int32, vsCommandControlType) uses the preface Addins.Progid. Chcete-li vytvořit jedinečný název.to create a unique name.

ButtonText
String

Povinná hodnota.Required. Název, který se má zobrazit v uživatelském rozhraní pro tento příkaz.The name to show in the UI for this command.

Tooltip
String

Povinná hodnota.Required. Text zobrazený v případě, že uživatel najede ukazatelem myši na libovolný ovládací prvek vázaný na nový příkaz.The text displayed when a user hovers the mouse pointer over any control bound to the new command.

MSOButton
Boolean

Povinná hodnota.Required. Musí být false .Must be false.

Bitmap
Object

Nepovinný parametr.Optional. ID rastrového obrázku, který má být zobrazen na tlačítkuThe ID of a bitmap to display on the button.

Rastrový obrázek může mít jednu z následujících možností:Bitmap can be one of the following: - Určitého Bitmap- A Bitmap

- K Icon- An Icon

- IPicture- An IPicture - ID prostředku rastrového obrázku 16x16 (ale nikoli prostředku ikony), který je k dispozici v doplňku.- The ID of a 16x16 bitmap resource (but not an icon resource) that is provided by the add-in. Visual Studio vypadá nejprve v satelitní knihovně DLL doplňku.Visual Studio looks first in the add-in's satellite DLL. Pokud prostředek nebyl nalezen, bude prohledána knihovna DLL doplňku.If the resource is not found there, the add-in DLL will be searched.

ContextUIGUIDs
Object[]

Nepovinný parametr.Optional. Identifikátor GUID, které určují kontexty prostředí (tj. režim ladění, režim návrhu a tak dále), zobrazí příkaz.The GUIDs that determine which environment contexts (that is, debug mode, design mode, and so on) show the command.

vsCommandStatusValue
Int32

Nepovinný parametr.Optional. Určuje, jestli je zakázaný stav příkazu neviditelný nebo zakázaný, když zadáte parametr ContextUIGUIDs a žádná není aktuálně aktivní.Determines whether the disabled state of the command is invisible or disabled when you supply a ContextUIGUIDs parameter and none are currently active. Viz třída vsCommandDisabledFlags.See vsCommandDisabledFlags.

CommandStyleFlags
Int32

Nepovinný parametr.Optional. Jeden z vsCommandStyle příznaků, zejména, vsCommandStylePict vsCommandStylePictAndText nebo vsCommandStyleText .One of the vsCommandStyle flags, in particular vsCommandStylePict, vsCommandStylePictAndText, or vsCommandStyleText.

ControlType
vsCommandControlType

Nepovinný parametr.Optional. Definuje typ ovládacího prvku, který se přidal při vytváření uživatelského rozhraní.Defines the control type added when the UI is created.

Návraty

Command

Pojmenovaný příkaz, který byl vytvořen.The named command that was created.

Atributy

Poznámky

Doplňky později mohou změnit ButtonText název tím, že reagují na QueryStatus metodu.Add-ins can later change the ButtonText name by responding to the QueryStatus method. Pokud text začíná znakem #, pak zbytek řetězce je celé číslo, které představuje ID prostředku v registrované satelitní knihovně DLL doplňku.If the text begins with #, then the rest of the string is an integer that represents a resource ID in the Add-in's registered satellite DLL.

Existují dva výchozí stavy příkazů: výchozí stav povoleno a výchozí stav viditelnosti.There are two default command states: the default enabled state and the default visibility state. Tyto výchozí stavy jsou důležité, pokud nelze najít obslužnou rutinu příkazu (protože součást není načtena nebo není implementována IDTCommandTarget ).These default states are important if a command handler cannot be found (because the component isn't loaded or doesn't implement IDTCommandTarget). Pokud je vaše komponenta načtena a implementuje IDTCommandTarget , výchozí hodnoty se nikdy nepoužijí.If your component is loaded and implements IDTCommandTarget, the default values never apply.

Existují dva zajímavé případy, kdy se používají výchozí stavy:There are two interesting cases where default states are used:

  1. Identifikátory GUID kontextu uživatelského rozhraní poskytujete prostřednictvím ContextUIGUIDs parametru.You provide UI context GUIDs via the ContextUIGUIDs parameter. V tomto případě viditelnost je zcela určena poskytnutými GUID kontextu.In this case visibility is entirely determined by the supplied context GUIDS. Pokud je kontext aktivní, je váš příkaz viditelný, jinak je skrytý.If the context is active, then your command is visible, otherwise it is hidden. Povolený stav je zcela určený výchozími hodnotami.Enabled state is entirely determined by the default values. Ve výchozím nastavení v aplikaci Visual Studio je příkaz vždy povolený, Pokud předáte vsCommandDisabledFlagsGrey, váš výchozí stav bude zakázán.By default in Visual Studio a command is always enabled if you pass vsCommandDisabledFlagsGrey then your default state will be disabled. Pokud předáte vsCommandDisabledFlagsEnabled nebo pokud tento parametr nezadáte, je výchozí stav povolen.If you pass vsCommandDisabledFlagsEnabled, or you simply don't supply this parameter, then your default state is enabled.

  2. Identifikátory GUID kontextu uživatelského rozhraní neposkytujete prostřednictvím ContextUIGUIDs parametru.You do not provide UI context GUIDs via the ContextUIGUIDs parameter. V takovém případě je viditelnost založena na příznacích, které předáte do vsCommandStatusValue výchozího stavu.In this case visibility is based on the flags you pass to vsCommandStatusValue or the default state. Výchozí viditelnost příkazu v sadě VS má být viditelná.Default command visibility in VS is to be visible. Pokud předáte vsCommandDisabledFlagsHidden, výchozí hodnota je neviditelná.If you pass vsCommandDisabledFlagsHidden here, the default is invisible. Povolený stav je stejný, jak je uvedeno v případu 1 výše (Určuje příznaky nebo výchozí chování VS).Enabled state is the same here as it is in case 1 above (determined by the flags and/or default VS behavior).

Doplněk může obdržet oznámení o volání prostřednictvím IDTCommandTarget rozhraní.The addin can receive invocation notification through the IDTCommandTarget interface. Tlačítko lze přidat pomocí OnConnection metody IDTExtensibility2 rozhraní.A button can be added by using the OnConnection method of the IDTExtensibility2 interface.

Platí pro