Metodo Commands.AddNamedCommand

Crea un comando con nome che viene salvato e reso disponibile al successivo avvio dell'ambiente anche qualora il componente aggiuntivo non venga caricato all'avvio dell'ambiente.

Spazio dei nomi:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Sintassi

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

Parametri

• AddInInstance
  Tipo: EnvDTE.AddIn

  Obbligatorio. L'oggetto AddIn aggiunge il nuovo comando.

• Name
  Tipo: String

  Obbligatorio. Forma breve del nome del nuovo comando. AddNamedCommand lo fa precedere da Addins.Progid. per creare un nome univoco.

• ButtonText
  Tipo: String

  Obbligatorio. Il nome da utilizzare se il comando è associato a un pulsante rappresentato dal nome invece che da un'icona.

• Tooltip
  Tipo: String

  Obbligatorio. Il testo visualizzato quando l'utente passa con il puntatore del mouse sopra a un controllo associato al nuovo comando.

• MSOButton
  Tipo: Boolean

  Obbligatorio. Indica se l'immagine del pulsante relativo al comando con nome è un'immagine Office. True = pulsante. Se MSOButton è False, Bitmap rappresenta l'ID di una risorsa bitmap 16x16 (non una risorsa icona) in una DLL di risorse di Visual C++ che deve risiedere in una cartella con l'identificatore delle impostazioni locali della lingua (1033 per l'inglese).

• Bitmap
  Tipo: Int32

  Facoltativa. L'ID della bitmap da visualizzare sul pulsante.

• ContextUIGUIDs
  Tipo: array<Object[]%

  Facoltativa. SafeArray di GUID che determina i contesti dell'ambiente (modalità di debug, di progettazione e così via) che mostrano il comando. Vedere vsCommandDisabledFlags.

• vsCommandDisabledFlagsValue
  Tipo: Int32

Valore restituito

Tipo: EnvDTE.Command
Oggetto Command.

Note

I componenti aggiuntivi possono in seguito modificare il nome ButtonText rispondendo al metodo QueryStatus. Se il testo inizia con "#", il resto della stringa è un numero intero che rappresenta un ID di risorsa nella DLL satellite registrata del componente aggiuntivo.

Il parametro ContextUIGUIDs e il parametro vsCommandStatusValue vengono utilizzati quando il componente aggiuntivo non è stato caricato e pertanto non può rispondere al metodo QueryStatus. Se ContextUIGUIDs è vuoto, il comando è abilitato finché il componente aggiuntivo non viene caricato e risponde a QueryStatus.

Il componente aggiuntivo può ricevere notifiche di chiamata tramite l'interfaccia IDTCommandTarget. È possibile aggiungere un pulsante utilizzando il metodo OnConnection dell'interfaccia IDTExtensibility2.

Esempi

' 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

Sicurezza di .NET Framework

• Attendibilità totale per il chiamante immediato. Impossibile utilizzare questo membro in codice parzialmente attendibile. Per altre informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.

Vedere anche

Riferimenti

Commands Interfaccia

Spazio dei nomi EnvDTE