Metodo ToolBoxItems.Add

  • Articolo

Crea un nuovo elemento e lo aggiunge alla Casella degli strumenti.

Spazio dei nomi:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Sintassi

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

Parametri

  • Name
    Tipo: System.String
    Obbligatorio.Una stringa che rappresenta la didascalia del nuovo elemento.
  • Data
    Tipo: System.Object
    Obbligatorio.Variabile Variant che rappresenta la stringa, il controllo o un altro elemento da aggiungere alla Casella degli strumenti.

Valore restituito

Tipo: EnvDTE.ToolBoxItem
Un oggetto ToolBoxItem.

Note

Il metodo ha esito negativo se l'insieme ToolBoxItems appartiene a un oggetto ToolBoxTab che è stato eliminato o se si cerca di aggiungere una scheda con un nome già esistente.

Per l'argomento Data, gli utenti di Visual C++ possono passare l'IUnknown di IDataObject.

Quando si aggiunge un assembly di tipo Format vsToolBoxItemFormatDotNETComponent, il valore passato al parametro Data può avere uno dei seguenti formati:

  • <AssemblyPath>, dove "<AssemblyPath>" è un percorso e un nome file che punta a un assembly gestito, quale C:\Libraries\MyAssembly.dll. Quando si utilizza questo formato, tutte le classi all'interno del file DLL vengono aggiunte alla Casella degli strumenti.

  • <AssemblyNameInTheGAC>, classe singola elencata come riferimento qualificato da assembly. Singole classi possono essere aggiunte come controlli nel caso in cui rappresentino riferimenti a un assembly situato nella Global Assembly Cache (GAC), come ad esempio: WindowControlLibrary1.UserControl1, WindowControlLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=<Your Token>. È possibile sostituire <Your Token> con il token della chiave pubblica, necessario per aggiungere l'assembly nella Global Assembly Cache.

Esempi

Nell'esempio riportato di seguito viene illustrato come aggiungere un documento di testo alla Casella degli strumenti:

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

Nell'esempio riportato di seguito viene illustrato come aggiungere un componente .NET alla Casella degli strumenti mediante un percorso al file. Il componente da aggiungere deve essere un controllo .NET, quale ad esempio un componente della Libreria di controlli Windows di 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

Sicurezza di .NET Framework

Vedere anche

Riferimenti

ToolBoxItems Interfaccia

Spazio dei nomi EnvDTE

Altre risorse

Procedura: controllare la Casella degli strumenti