Commands.AddCommandBar, méthode

Crée une barre de commandes qui est enregistrée et qui sera disponible au prochain démarrage de l'environnement.

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

Syntaxe

'Déclaration
Function AddCommandBar ( _
    Name As String, _
    Type As vsCommandBarType, _
    CommandBarParent As Object, _
    Position As Integer _
) As Object

Object AddCommandBar(
    string Name,
    vsCommandBarType Type,
    Object CommandBarParent,
    int Position
)

Object^ AddCommandBar(
    [InAttribute] String^ Name, 
    [InAttribute] vsCommandBarType Type, 
    [InAttribute] Object^ CommandBarParent, 
    [InAttribute] int Position
)

abstract AddCommandBar : 
        Name:string * 
        Type:vsCommandBarType * 
        CommandBarParent:Object * 
        Position:int -> Object

function AddCommandBar(
    Name : String, 
    Type : vsCommandBarType, 
    CommandBarParent : Object, 
    Position : int
) : Object

Paramètres

• Name
  Type : String

  Obligatoire. Nom de la nouvelle barre de commandes.

• Type
  Type : EnvDTE.vsCommandBarType

  Obligatoire. Constante vsCommandBarType qui détermine le type de la barre de commandes :

• CommandBarParent
  Type : Object

  Optionnel. Objet Office CommandBar auquel la nouvelle barre de commandes doit être ajoutée. (Ce paramètre est toutefois requis si Type est vsCommandBarTypeMenu.)

• Position
  Type : Int32

  Optionnel. Position d'index (à partir de 1) où placer la nouvelle barre de commandes dans la barre de commandes.

Valeur de retour

Type : Object
Objet CommandBar.

Notes

L'objet CommandBar est membre du modèle objet Microsoft Office.

La barre de commandes ajoutée à l'aide de cette méthode est une barre de commandes permanente, disponible dans chaque session IDE, que le complément soit chargé ou non. Vous devez utiliser cette méthode pour ajouter une barre de commandes uniquement si vous voulez une barre de commandes permanente. Vous devez appeler cette méthode une seule fois lorsque le complément est chargé pour la première fois. Si vous souhaitez une barre de commandes temporaire qui s'affiche uniquement lorsque le complément est réellement chargé, vous devez utiliser la méthode DTE.CommandBars.Add lorsque vous chargez le complément, puis appeler la méthode DTE.CommandBars.Remove lorsque vous déchargez le complément.

Étant donné qu'une barre de commandes permanente apparaît même lorsque le complément n'est pas chargé, vous devez être sûr de la supprimer lorsque le complément est désinstallé. Par conséquent, vous devez utiliser un MSI pour installer et désinstaller votre complément, et pour ajouter une action personnalisée à votre programme de désinstallation.

Pour plus d'informations sur l'ajout et la suppression des barres de commandes permanentes et temporaires, consultez Procédure : Ajout de boutons, barres de commandes et barres d'outils dans Visual Studio .NET à partir d'un complément et Procédure : Supprimer des commandes et des éléments d'interface utilisateur lors de la désinstallation du complément Visual Studio .NET.

Exemples

' Macro code.
Imports Microsoft.VisualStudio.CommandBars
Sub AddCommandBarExample()
   ' 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 customin, customout As Object
   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.
   cmdbarobj = cmds.AddCommandBar("Mycmdbar", _
   vsCommandBarType.vsCommandBarTypeToolbar)
   MsgBox("Commandbar name: " & cmdbarobj.Name)
   cmdobj = cmds.AddNamedCommand(colAddins.Item(1), "mycommand", _
   "mycommand", "tooltip for mycommand", True)
End Sub

Sécurité .NET Framework

• Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

Commands Interface

EnvDTE, espace de noms