ToolBoxItems.Add, méthode

Article
05/16/2015

Crée un élément et l'ajoute à l'objet ToolBox.

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

Syntaxe

'Déclaration
Function Add ( _
    Name As String, _
    Data As Object, _
    Format As vsToolBoxItemFormat _
) As ToolBoxItem

ToolBoxItem Add(
    string Name,
    Object Data,
    vsToolBoxItemFormat Format
)

ToolBoxItem^ Add(
    [InAttribute] String^ Name, 
    [InAttribute] Object^ Data, 
    [InAttribute] vsToolBoxItemFormat Format
)

abstract Add : 
        Name:string * 
        Data:Object * 
        Format:vsToolBoxItemFormat -> ToolBoxItem

function Add(
    Name : String, 
    Data : Object, 
    Format : vsToolBoxItemFormat
) : ToolBoxItem

Paramètres

Name
Type : String

Obligatoire. Chaîne représentant la légende du nouvel élément.

Data
Type : Object

Obligatoire. Variable de type Variant représentant la chaîne, le contrôle ou un autre élément à ajouter à l'objet ToolBox.

Format
Type : EnvDTE.vsToolBoxItemFormat

Optionnel. Constante vsToolBoxItemFormat indiquant le format du nouvel élément.

Valeur de retour

Type : EnvDTE.ToolBoxItem
Objet ToolBoxItem.

Notes

Cette méthode échoue si la collection ToolBoxItems appartient à un objet ToolBoxTab qui a été supprimé, ou si vous essayez d'ajouter un onglet portant un nom déjà existant.

Pour l'argument Data, les utilisateurs de Visual C++ peuvent transmettre IUnknown de IDataObject.

Lorsque vous ajoutez un assembly dont le type de Format est vsToolBoxItemFormatDotNETComponent, la valeur passée au paramètre Data peut prendre l'un des formats suivants :

<AssemblyPath> — Où « <AssemblyPath> » est un nom de chemin d'accès et de fichier pointant vers un assembly managé, tel que C:\Libraries\MyAssembly.dll. Lorsque vous utilisez ce format, toutes les classes du fichier .DLL sont ajoutées à la boîte à outils.
<AssemblyNameInTheGAC> — Il s'agit d'une classe unique répertoriée sous forme de référence qualifiée d'assembly. Des classes uniques peuvent être ajoutées sous forme de contrôles dans la mesure où il s'agit de références à un assembly qui se trouve dans le Global Assembly Cache (GAC), par exemple WindowControlLibrary1.UserControl1, WindowControlLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=<Your Token>. (Vous devez remplacer <Your Token> par votre jeton de clé publique, lequel est requis pour ajouter votre assembly au GAC.)

Exemples

L'exemple suivant illustre l'ajout d'un document texte à la boîte à outils.

Sub ToolBoxAddExample1()
    ' This adds a Text item to the first tab of the ToolBox.
    ' Define the variables and create an object reference to the IDE's  
    ' ToolBox object.
    Dim win As Window = DTE.Windows.Item(Constants.vsWindowKindToolbox)
    Dim tlbox As ToolBox = win.Object
    Dim tbxTabs As ToolBoxTabs

    ' Create an object reference to the ToolBoxTabs object.
    tbxTabs = tlbox.ToolBoxTabs

    ' Add a new Text item to the first tab in the ToolBox.
    tbxTabs.Item(1).ToolBoxItems.Add("New Text Item", "Some text to _
    add to the document.", vsToolBoxItemFormat.vsToolBoxItemFormatText)
End Sub

L'exemple suivant montre comment ajouter un composant .NET à la boîte à outils en utilisant un chemin d'accès au fichier. Le composant à ajouter doit être un contrôle .NET, tel qu'un composant Bibliothèque de contrôles Windows de Visual Basic.

Sub ToolBoxItemAddExample2()
    Try
        Dim tlBox As ToolBox
        tlBox = CType(DTE.Windows.Item(Constants. _
        vsWindowKindToolbox).Object, EnvDTE.ToolBox)
        ' Create a new tab called "My Controls."
        Dim tlBoxTab As ToolBoxTab = tlBox.ToolBoxTabs. _
        Add("My Controls")
        ' Set focus to the new Toolbox tab.
        tlBoxTab.Activate()
        ' Add a .NET control as a new control in the new ToolBox tab. 
        ' The constant "vsToolBoxItemFormatDotNETComponent" alerts the 
        ' ToolBox to the type of control you are adding.
        tlBoxTab.ToolBoxItems.Add("MyDotNetControl", _
        "C:\Libraries\ADotNetControl.dll(", _
        vsToolBoxItemFormat.vsToolBoxItemFormatDotNETComponent)
    Catch ex As System.Exception
        ' Display any errors that occur.
        MsgBox("ERROR: " & ex.Message)
    End Try
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

ToolBoxItems Interface

EnvDTE, espace de noms

Autres ressources

Comment : contrôler la boîte à outils

Partager via