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

Definicja

Tworzy nazwane polecenie zapisane w środowisku i udostępniane przy następnym uruchomieniu środowiska, nawet jeśli dodatek nie jest ładowany podczas uruchamiania środowiska.

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

Wymagane. AddInDodaj nowe polecenie.

Name
String

Wymagane. Krótka forma nazwy nowego polecenia. AddNamedCommand2(AddIn, String, String, String, Boolean, Object, Object[], Int32, Int32, vsCommandControlType) używa dodatków przedczołowych . ProgID. do utworzenia unikatowej nazwy.

ButtonText
String

Wymagane. Nazwa, która ma być wyświetlana w interfejsie użytkownika dla tego polecenia.

Tooltip
String

Wymagane. Tekst wyświetlany, gdy użytkownik umieści wskaźnik myszy nad dowolnym formantem powiązanym z nowym poleceniem.

MSOButton
Boolean

Wymagane. Musi być false .

Bitmap
Object

Opcjonalny. Identyfikator mapy bitowej, która ma być wyświetlana na przycisku.

Mapa bitowa może być jedną z następujących: - Z Bitmap

- Wskazani Icon

- IPicture - Identyfikator zasobu 16x16 mapy bitowej (ale nie zasobu ikony), który jest dostarczany przez dodatek. Program Visual Studio najpierw przeszukuje satelitarną bibliotekę DLL dodatku. Jeśli zasób nie zostanie tam znaleziony, będzie przeszukiwany plik DLL dodatku.

ContextUIGUIDs
Object[]

Opcjonalny. Identyfikatory GUID, które określają konteksty środowiska (to znaczy tryb debugowania, tryb projektowania itd.), pokazują polecenie.

vsCommandStatusValue
Int32

Opcjonalny. Określa, czy stan wyłączony polecenia jest niewidoczny, czy wyłączony, gdy podasz parametr ContextUIGUIDs , a żaden z nich nie jest obecnie aktywny. Zobacz: vsCommandDisabledFlags.

CommandStyleFlags
Int32

Opcjonalny. Jedna z vsCommandStyle flag, w szczególności, vsCommandStylePict vsCommandStylePictAndText lub vsCommandStyleText .

ControlType
vsCommandControlType

Opcjonalny. Definiuje typ formantu dodanego podczas tworzenia interfejsu użytkownika.

Zwraca

Command

Nazwane polecenie, które zostało utworzone.

Atrybuty

Uwagi

Dodatki mogą później zmienić ButtonText nazwę przez odpowiadanie na QueryStatus metodę. Jeśli tekst zaczyna się od #, pozostała część ciągu jest liczbą całkowitą reprezentującą identyfikator zasobu w zarejestrowanej satelitarnej bibliotece DLL dodatku.

Istnieją dwa domyślne Stany poleceń: domyślny stan włączony i domyślny stan widoczności. Te domyślne Stany są ważne, jeśli nie można odnaleźć programu obsługi poleceń (ponieważ składnik nie został załadowany lub nie jest zaimplementowany IDTCommandTarget ). Jeśli składnik jest ładowany i implementuje IDTCommandTarget , wartości domyślne nigdy nie są stosowane.

Istnieją dwa interesujące przypadki, w których są używane domyślne Stany:

  1. Identyfikatory GUID kontekstu interfejsu użytkownika można podawać za pośrednictwem ContextUIGUIDs parametru. W tym przypadku widoczność jest całkowicie określana przez dostarczone identyfikatory GUID kontekstu. Jeśli kontekst jest aktywny, polecenie jest widoczne, w przeciwnym razie jest ukryte. Włączony stan jest całkowicie określony przez wartości domyślne. Domyślnie w programie Visual Studio polecenie jest zawsze włączone, jeśli przejdziesz do vsCommandDisabledFlagsGrey, a stan domyślny zostanie wyłączony. Jeśli przejdziesz do vsCommandDisabledFlagsEnabled lub po prostu nie podasz tego parametru, stan domyślny jest włączony.

  2. Nie podasz identyfikatorów GUID kontekstu interfejsu użytkownika za pomocą ContextUIGUIDs parametru. W tym przypadku widoczność jest zależna od flag, które są przekazywane vsCommandStatusValue lub domyślne. Domyślny widoczność poleceń w programie VS ma być widoczna. Jeśli w tym miejscu zostanie przekazany vsCommandDisabledFlagsHidden, wartość domyślna jest niewidoczna. Włączony stan jest taki sam, jak w przypadku 1 powyżej (określony przez flagi i/lub domyślne zachowanie programu VS).

Dodatek może odbierać powiadomienia o wywołaniu za pomocą IDTCommandTarget interfejsu. Przycisk można dodać za pomocą OnConnection metody IDTExtensibility2 interfejsu.

Dotyczy