Condividi tramite

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

    Obbligatorio. AddIn che aggiunge il nuovo comando.

  • Name
    Tipo: String

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

  • ButtonText
    Tipo: String

    Obbligatorio. Il nome da visualizzare nell'interfaccia utente per questo comando.

  • 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. Deve essere false.

  • Bitmap
    Tipo: Object

    Parametro facoltativo. L'ID della bitmap da visualizzare sul pulsante.

    Bitmap può 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 cerca innanzitutto nella DLL satellite del componente aggiuntivo. Se la risorsa non è vi stata trovata, il componente aggiuntivo DLL verrà cercato.

  • ContextUIGUIDs
    Tipo: array<Object[]%

    Parametro facoltativo. I GUID che determinano quali contesti dell'ambiente (ovvero modalità di debug, modalità progettazione, e così via) indica al comando.

  • vsCommandStatusValue
    Tipo: Int32

    Parametro facoltativo. Determina se lo stato disabilitato il comando è quando si immette un parametro ContextUIGUIDs e non sono attualmente attiva invisibile o disabilitarlo. Vedere vsCommandDisabledFlags.

  • ControlType
    Tipo: EnvDTE80.vsCommandControlType

    Parametro facoltativo. Definisce il tipo di controllo aggiunto alla creazione dell'interfaccia utente.

Valore restituito

Tipo: Command
Comando denominato creato.

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 intero che rappresenta un ID di risorsa nella DLL satellite registrata del componente aggiuntivo.

Esistono due stati di comando predefiniti: lo stato attivo predefinito e lo stato predefinito della visibilità. Questi stati predefiniti sono importanti se un gestore comando non è disponibile perché il componente non viene caricata o non implementa IDTCommandTarget). Se il componente viene caricata e implementa IDTCommandTarget, i valori predefiniti non vengono applicate mai.

Esistono due casi interessanti in cui gli stati predefiniti vengono utilizzati:

  1. Fornire il contesto GUID dell'interfaccia utente tramite il parametro ContextUIGUIDs. In questo caso la visibilità dipende interamente dal contesto specificato GUIDS. Se il contesto è attivo, il comando è visibile in caso contrario, viene nascosto. Lo stato attivo è interamente determinato dai valori predefiniti. Per impostazione predefinita in Visual Studio il comando è sempre abilitato se si passa il vsCommandDisabledFlagsGrey quindi che lo stato predefinito sarà disabilitato. Se si passa vsCommandDisabledFlagsEnabled, o non fornire semplicemente questo parametro, è lo stato predefinito è abilitato.

  2. Non fornire il contesto GUID dell'interfaccia utente tramite il parametro ContextUIGUIDs. In questo caso la visibilità è basata su flag passati a vsCommandStatusValue o lo stato predefinito. La visibilità dei comandi predefinita in VS debba essere visibile. Se sessione vsCommandDisabledFlagsHidden di seguito, l'impostazione predefinita è invisibile. Lo stato attivo è lo stesso di seguito come nel caso 1 precedente (determinato dai flag e/o dall'impostazione predefinita VS comportamento).

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