Metodo Commands.AddNamedCommand

  • Articolo

Crea un comando denominato che viene salvato dall'ambiente e reso disponibile la volta successiva che l'ambiente verrà avviata, anche se il componente aggiuntivo non viene 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.AddIn L'oggetto sta aggiungendo del nuovo comando.
  • Name
    Tipo: System.String
    obbligatorio.La forma breve del nome per il nuovo comando. AddNamedCommand utilizza la prefazione Addins.Progid. per creare un nome univoco.
  • ButtonText
    Tipo: System.String
    obbligatorio.Il nome da utilizzare se il comando è associato a un pulsante che consente di visualizzare per nome anziché dall'icona.
  • Tooltip
    Tipo: System.String
    obbligatorio.Il testo visualizzato quando l'utente posiziona il puntatore del mouse su qualsiasi limite del controllo al nuovo comando.
  • MSOButton
    Tipo: System.Boolean
    obbligatorio.Indica se l'immagine denominata pulsante di comando è un'immagine di Office. True = pulsante.se MSOButton viene False, quindi Bitmap è l'ID di una risorsa bitmap di 16x16 (ma non di una risorsa icona) in una DLL delle risorse di Visual C++ che deve essere presente in una cartella con l'identificatore impostazioni locali della lingua (1033 per la lingua inglese).
  • Bitmap
    Tipo: System.Int32
    facoltativo.L'ID di una bitmap da visualizzare sul pulsante.
  • ContextUIGUIDs
    Tipo: array<System.Object[]%
    facoltativo.SafeArray di GUID che determina quali contesti dell'ambiente (ovvero modalità di debug, modalità progettazione, e così via) per indicare al comando.vedere vsCommandDisabledFlags.

Valore restituito

Tipo: EnvDTE.Command
In Command oggetto.

Note

I componenti aggiuntivi possono successivamente modificare ButtonText nome rispondere a QueryStatus metodo.Se il testo inizia con “#„, il resto della stringa è un Integer che rappresenta un ID di risorsa nella DLL satellite registrato aggiuntivo.

ContextUIGUIDs parametro e vsCommandStatusValue il parametro viene utilizzato quando il componente aggiuntivo non viene caricato e non può rispondere quindi a QueryStatus metodo.se ContextUIGUIDs è vuoto, il comando viene attivato fino a caricare e possa rispondere il componente aggiuntivo a QueryStatus.

il componente aggiuntivo può ricevere la notifica di chiamata con IDTCommandTarget interfaccia.Un pulsante può essere aggiunti tramite OnConnection metodo di IDTExtensibility2 interfaccia

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

Vedere anche

Riferimenti

Commands Interfaccia

Spazio dei nomi EnvDTE