Metodo Commands2.AddNamedCommand2

  • Articolo

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:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Sintassi

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

Parametri

  • AddInInstance
    Tipo: EnvDTE.AddIn
    Obbligatorio.L'oggetto AddIn aggiunge il nuovo comando.
  • Name
    Tipo: System.String
    Obbligatorio.Forma breve del nome del nuovo comando.AddNamedCommand2 la fa precedere da Addins.Progid. per creare un nome univoco.
  • ButtonText
    Tipo: System.String
    Obbligatorio.Il nome da utilizzare se il comando è associato a un pulsante rappresentato dal nome invece che da un'icona.
  • Tooltip
    Tipo: System.String
    Obbligatorio.Il testo visualizzato quando l'utente passa con il puntatore del mouse sopra a un controllo associato al nuovo comando.
  • MSOButton
    Tipo: System.Boolean
    Obbligatoria.Indica come viene interpretato il parametro bitmap.
    Se il valore è true, Bitmap rappresenta l'ID di una bitmap di Microsoft Office.
    Se MSOButton è false, Bitmap può quindi essere uno dei seguenti:
    - Un oggetto Bitmap
    - Un oggetto Icon
    - Immagine IPicture
    - ID di una risorsa bitmap 16x16 (ma non una risorsa icona) fornita dal componente aggiuntivo.Visual Studio verrà visualizzato inizialmente nel DLL satellite del componente aggiuntivo.Se la risorsa non è vi stata trovata, il componente aggiuntivo DLL verrà cercato.
  • Bitmap
    Tipo: System.Object
    Facoltativo.L'ID della bitmap da visualizzare sul pulsante.Vedere MSOButton.
  • ContextUIGUIDs
    Tipo: array<System.Object[]%
    Facoltativo.SafeArray di GUID che determina i contesti dell'ambiente (modalità di debug, di progettazione e così via) che mostrano il comando.Vedere vsCommandDisabledFlags.
  • vsCommandStatusValue
    Tipo: System.Int32
    Facoltativo.Determina se lo stato disabilitato del comando è invisibile o a visibilità ridotta quando si fornisce un ContextUIGUIDs e nessun elemento è correntemente attivo.
  • CommandStyleFlags
    Tipo: System.Int32
    Facoltativo.Determina lo stato del comando quando si fornisce un oggetto ContextUIGUIDs e nessuno dei contesti specificati è attualmente attivo.Questo parametro deve sempre includere vsCommandStatusSupported.Se include anche vsCommandStatusEnabled, il comando verrà abilitato.

Valore restituito

Tipo: EnvDTE.Command
Comando denominato creato.

Note

Per informazioni su come ottenere i valori ID bitmap dei pulsanti MSO, vedere Listing Button Faces in the Command Bar for the Microsoft Office System (informazioni in lingua inglese).

I componenti aggiuntivi possono in seguito modificare il nome ButtonText rispondendo al metodo QueryStatus. Se il testo inizia con #, il resto della stringa è un 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 mediante il metodo OnConnection dell'interfaccia IDTExtensibility2.

Sicurezza di .NET Framework

Vedere anche

Riferimenti

Commands2 Interfaccia

Spazio dei nomi EnvDTE80