Udostępnij za pośrednictwem

Metoda Commands2.AddNamedCommand2 —

  • Artykuł

Tworzy nazwane polecenie, które jest zapisywany przez środowisko i udostępniane przy następnym uruchomieniu środowiska, nawet jeśli dodatek nie jest ładowany podczas uruchamiania środowiska.

Przestrzeń nazw:  EnvDTE80
Zestaw:  EnvDTE80 (w EnvDTE80.dll)

Składnia

'Deklaracja
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

    Wymagany.AddIn , Że jest dodanie nowego polecenia.

  • Name
    Typ: String

    Wymagany.Krótka forma nazwę dla nowego polecenia.AddNamedCommand2używa "Wstępu" Addins.Progid. do utworzenia unikatowej nazwy.

  • ButtonText
    Typ: String

    Wymagany.Nazwę, aby wyświetlić w interfejsie użytkownika dla tego polecenia.

  • Tooltip
    Typ: String

    Wymagany.Tekst wyświetlany, gdy użytkownik najedzie wskaźnikiem myszy każdy formant powiązany z nowego polecenia.

  • MSOButton
    Typ: Boolean

    Wymagany.Must be false.

  • Bitmap
    Typ: Object

    Opcjonalnie.Identyfikator mapy bitowej do wyświetlania na przycisku.

    Bitmap może mieć postać:

    -ABitmap

    -Icon

    -IPicture

    -Identyfikator zasobu mapa bitowa 16 x 16 (ale nie zasób ikony) dostarczonego przez ten dodatek.Program Visual Studio wygląda pierwszy w dodatek w towarzyszącej biblioteki DLL.Jeśli zasób nie zostaną znalezione, DLL dodatku będzie przeszukiwana.

  • ContextUIGUIDs
    Typ: array<Object[]%

    Opcjonalnie.Identyfikatory GUID określających polecenie Pokaż które kontekstów środowiska (czyli tryb debugowania, tryb projektowania i tak dalej).

  • vsCommandStatusValue
    Typ: Int32

    Opcjonalnie.Określa, czy stan wyłączenia polecenia jest niewidoczne lub wyłączone podczas zasilania ContextUIGUIDs parametru i nie są aktualnie aktywne.Zobacz vsCommandDisabledFlags.

Wartość zwracana

Typ: Command
Nazwane polecenie, który został utworzony.

Uwagi

Dodatki można później zmienić ButtonText nazwa odpowiadając na QueryStatus metody.Jeśli tekst zaczyna się od #, reszta ciąg jest liczba całkowita, która reprezentuje identyfikator zasobu w dodatek w towarzyszącej zarejestrowane biblioteki DLL.

Istnieją dwa stany polecenia domyślne: domyślnie włączona i Państwa, widoczność domyślna.Państwa te domyślne są ważne, jeśli nie można odnaleźć programu obsługi polecenia (ponieważ składnik nie jest załadowany lub nie implementuje IDTCommandTarget).Jeśli składnik jest ładowany i implementuje IDTCommandTarget, nigdy nie stosować wartości domyślnych.

Istnieją dwa przypadki interesujące, gdy stosowane są domyślnymi stanami:

  1. Zapewniają identyfikatorów GUID kontekście interfejsu użytkownika za pomocą ContextUIGUIDs parametru.W tym przypadku widoczności całkowicie zależy od kontekstu podane identyfikatory GUID.Jeśli kontekst jest aktywny, a następnie polecenia jest widoczny, w przeciwnym razie jest on ukryty.Stan włączenia całkowicie jest określana przez wartości domyślne.Domyślnie w programie Visual Studio polecenia jest zawsze włączone, a następnie domyślny stan zostanie wyłączona w przypadku przekazania vsCommandDisabledFlagsGrey.Jeśli przebieg vsCommandDisabledFlagsEnabled lub po prostu nie zostanie podane ten parametr, domyślny stan jest włączony.

  2. Nie podasz identyfikatory GUID kontekście interfejsu użytkownika za pomocą ContextUIGUIDs parametru.W tym przypadku widoczności opiera się na flagi są przekazywane do vsCommandStatusValue lub stan domyślny.Widoczność domyślna polecenia w VS ma być widoczne.Jeśli w tym miejscu możesz przejść vsCommandDisabledFlagsHidden, wartość domyślna jest niewidoczny.Stan włączenia jest samo tutaj, jak to jest w przypadku 1 (ustalona poprzez flagi lub domyślne zachowanie VS) powyżej.

Dodatek może odbierać powiadomienia wywołania przez IDTCommandTarget interfejsu.Przycisk mogą być dodawane za pomocą OnConnection metody IDTExtensibility2 interfejsu.

Zabezpieczenia programu .NET Framework

Zobacz też

Informacje

Commands2 Interfejs

Przestrzeń nazw EnvDTE80