Udostępnij za pośrednictwem

Metoda Commands.AddNamedCommand —

  • Artykuł

Tworzy nazwane polecenie, które jest zapisywane przez środowisko naturalne oraz dostępne przy następnym uruchomieniu środowiska, nawet jeśli dodatek nie jest ładowany podczas uruchamiania środowiska.

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

Składnia

'Deklaracja
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
    Wymagane.AddIn Obiektu jest dodanie nowego polecenia.
  • Name
    Typ: System.String
    Wymagane.Krótka forma nazwy dla nowego polecenia. AddNamedCommand używa "Wstępu" Addins.Progid. do tworzenia unikatowych nazw.
  • ButtonText
    Typ: System.String
    Wymagane.Nazwa, aby użyć, jeżeli polecenie jest związany przycisk, który jest wyświetlany przez nazwę zamiast ikony.
  • Tooltip
    Typ: System.String
    Wymagane.Tekst wyświetlany, gdy użytkownik nakieruje wskaźnik myszy na każdy formant powiązany z nowego polecenia.
  • MSOButton
    Typ: System.Boolean
    Wymagane.Wskazuje, czy obraz przycisku polecenia nazwany jest obraz pakietu Office. True = przycisk.Jeśli MSOButton jest False, następnie Bitmap jest Identyfikatorem zasobu mapa bitowa 16 x 16 (ale nie zasób ikony) w Visual C++ zasobu biblioteki DLL, która musi znajdować się w folderze z identyfikatorem ustawień regionalnych języka (1033 dla języka angielskiego).
  • Bitmap
    Typ: System.Int32
    Opcjonalne.Identyfikator mapy bitowej do wyświetlenia na przycisku.
  • ContextUIGUIDs
    Typ: array<System.Object[]%
    Opcjonalne.Element SafeArray z GUID, który określa, które kontekstów środowiska (to znaczy tryb debugowania, tryb projektowania i tak dalej) Pokaż polecenie.See vsCommandDisabledFlags..

Wartość zwracana

Typ: EnvDTE.Command
A Command object.

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 dodatku 's satelitarnej zarejestrowanych biblioteki DLL.

ContextUIGUIDs Parametr i vsCommandStatusValue parametr są używane, gdy dodatek nie jest załadowany i dlatego nie może odpowiedzieć na QueryStatus metody.Jeśli ContextUIGUIDs jest pusta, a następnie polecenie jest włączone, dopóki nie jest ładowany i można odpowiedzieć na dodatek QueryStatus.

Dodatek może odbierać wywołania notyfikacji poprzez IDTCommandTarget interfejsu.Przycisk mogą być dodawane za pomocą OnConnection metoda IDTExtensibility2 interfejsu

Przykłady

' Macro code.
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

Zabezpieczenia programu .NET Framework

Zobacz też

Informacje

Commands Interfejs

Przestrzeń nazw EnvDTE