Metoda Commands2.AddNamedCommand —

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 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: AddIn

  Wymagany.AddIn Obiekt, który jest dodanie nowego polecenia.

• Name
  Typ: String

  Wymagany.Krótka forma nazwę dla nowego polecenia.AddNamedCommandprefaces to z "Addins.Progid." Aby utworzyć unikatową nazwę.

• ButtonText
  Typ: String

  Wymagany.Nazwa używana Jeśli polecenie jest związany przycisk, który jest wyświetlany, według nazwy, a nie ikona.

• 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.Powinny być zawsze false.

• Bitmap
  Typ: Int32

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

• ContextUIGUIDs
  Typ: array<Object[]%

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

• vsCommandDisabledFlagsValue
  Typ: Int32

  Opcjonalnie.Określa stan polecenia, gdy zostanie podana ContextUIGUIDs i żaden z określonych kontekstach nie są aktualnie aktywne.Ten parametr zawsze powinien zawierać vsCommandStatusSupported.Jeśli są również vsCommandStatusEnabled, polecenie będzie aktywny.

Wartość zwracana

Typ: Command
Obiekt Command.

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.

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

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

Przykłady

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

• Pełne zaufanie do bezpośredniego wywołującego. Tego elementu członkowskiego nie można używać w kodzie częściowo zaufanym. Aby uzyskać więcej informacji, zobacz Używanie bibliotek pochodzących z częściowo zaufanego kodu.

Zobacz też

Informacje

Commands2 Interfejs

Przestrzeń nazw EnvDTE80