Partager via

Commands2.AddNamedCommand2, méthode

  • Article

Crée une commande nommée qui est enregistrée par l'environnement et qui sera disponible au prochain démarrage de cet environnement, même si le complément n'est pas chargé au démarrage de l'environnement.

Espace de noms :  EnvDTE80
Assembly :  EnvDTE80 (dans EnvDTE80.dll)

Syntaxe

'Déclaration
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

Paramètres

  • AddInInstance
    Type : AddIn

    Requis. AddIn qui ajoute la nouvelle.

  • Name
    Type : String

    Requis. Forme courte du nom de votre nouvelle commande. AddNamedCommand2 utilise la préface Addins.Progid. pour créer un nom unique.

  • ButtonText
    Type : String

    Requis. Nom à afficher dans l'interface utilisateur pour cette commande.

  • Tooltip
    Type : String

    Requis. Texte qui s'affiche lorsqu'un utilisateur arrête le pointeur de la souris sur un contrôle lié à la nouvelle commande.

  • MSOButton
    Type : Boolean

    Requis. Doit être false.

  • Bitmap
    Type : Object

    Optionnel. ID d'une bitmap à afficher sur le bouton.

    Bitmap peut avoir l'une des valeurs suivantes :

    - Un Bitmap.

    - Un Icon.

    - IPicture

    - L'ID d'une ressource bitmap 16x16 (et non d'une ressource icône) qui est fournie par le complément. Visual Studio recherche d'abord dans la DLL satellite du complément. Si la ressource est introuvable, la DLL du complément sera recherchée.

  • ContextUIGUIDs
    Type : array<Object[]%

    Optionnel. Le GUID qui déterminent quels contextes d'environnement (autrement dit, mode débogage, mode Design, etc.) indiquent la commande.

  • vsCommandStatusValue
    Type : Int32

    Optionnel. Détermine si l'état désactivé de la commande est lorsque vous fournissez un paramètre ContextUIGUIDs et aucun n'est actuellement - actif invisible ou désactivé. Consultez vsCommandDisabledFlags.

Valeur de retour

Type : Command
Commande nommée qui a été créée.

Notes

Les compléments peuvent changer ultérieurement le nom ButtonText en répondant à la méthode QueryStatus. Si le texte commence par "#", le reste de la chaîne est un entier qui représente un identificateur de ressource dans la DLL satellite enregistrée du complément.

Il existe deux états de commande par défaut : l'état activé par défaut et l'état par défaut de visibilité. Ces états par défaut sont importants si un gestionnaire de commandes est introuvable (car le composant n'est pas chargé ou n'implémente pas IDTCommandTarget). Si votre composant est chargé et implémente IDTCommandTarget, les valeurs par défaut ne s'appliquent pas.

Deux cas intéressants où les états par défaut sont utilisés :

  1. Vous fournissez le contexte GUID d'interface utilisateur via le paramètre ContextUIGUIDs. Dans ce cas la visibilité est complètement déterminée par le contexte fourni GUIDS. Si le contexte est actif, votre commande est visible, sinon elle est masquée. L'état actif est entièrement déterminé par les valeurs par défaut. Par défaut dans Visual Studio une commande est toujours activée si vous passez le vsCommandDisabledFlagsGrey pendant que votre état par défaut sera désactivé. Si vous passez vsCommandDisabledFlagsEnabled, ou bien simplement ne fournissez pas ce paramètre, votre état par défaut est activé.

  2. Vous ne fournissez pas le contexte GUID d'interface utilisateur via le paramètre ContextUIGUIDs. Dans ce cas la visibilité est basé sur les indicateurs que vous passez à vsCommandStatusValue ou à l'état par défaut. La visibilité de commandes par défaut dans VS doit être visible. Si vous lancez vsCommandDisabledFlagsHidden ici, la valeur par défaut est invisible. L'état actif est le même ici comme elle est dans le cas 1 ci-dessus (déterminé par les indicateurs et/ou la valeur par défaut VS le comportement).

Le complément peut recevoir une notification d'invocation par l'intermédiaire de l'interface IDTCommandTarget. Un bouton peut être ajouté en utilisant la méthode OnConnection de l'interface IDTExtensibility2.

Sécurité .NET Framework

Voir aussi

Référence

Commands2 Interface

EnvDTE80, espace de noms