ToolBoxItem2.Collection Property

  • Article

Gets the collection containing the ToolBoxItem object supporting this property.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
ReadOnly Property Collection As ToolBoxItems

ToolBoxItems Collection { get; }

property ToolBoxItems^ Collection {
    ToolBoxItems^ get ();
}

abstract Collection : ToolBoxItems

function get Collection () : ToolBoxItems

Property Value

Type: EnvDTE.ToolBoxItems
A ToolBoxItems collection.

Implements

ToolBoxItem.Collection

Examples

This example selects the second ToolBoxItem2 item and displays its name in a message box. The example also displays the name of each toolbox item contained in the second toolbox tab. For more information about how to run this example as an add-in, see How to: Compile and Run the Automation Object Model Code Examples.

Imports EnvDTE
Imports EnvDTE80
Public Sub OnConnection(ByVal application As Object, _
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    ToolBoxItemCollectionExample(_applicationObject)
End Sub
Sub ToolBoxItemCollectionExample(ByVal dte As DTE2)
    Dim tlBox As ToolBox
    Dim tbxTabs As ToolBoxTabs
    Dim tbxTab As ToolBoxTab2
    Dim tbxItem As ToolBoxItem2
    Dim aString As String = "All the toolbox items in the collection: _
    " & vbCr
    ' Before running this example, open a Windows Application project.
    Try
        ' Create an object reference to the IDE's ToolBox object and
        ' its tabs.
        tlBox = CType(_applicationObject.Windows.Item _
         (Constants.vsWindowKindToolbox).Object, ToolBox)
        tbxTabs = tlBox.ToolBoxTabs
        ' Select the second ToolBox tab.
        tbxTab = CType(tbxTabs.Item(2), ToolBoxTab2)
        tbxTab.Activate()
        MsgBox("Toolbox tab name: " & tbxTab.Name)
        tbxItem = CType(tbxTab.ToolBoxItems.Item(2), ToolBoxItem2)
        MsgBox("ToolBox item name: " & tbxItem.Name)
        For Each temp As ToolBoxItem2 In tbxItem.Collection
            aString = aString & (temp.Name) & vbCr
        Next
        MsgBox(aString)
    Catch ex As System.Exception
        MsgBox("ERROR: " & ex.Message)
    End Try
End Sub

using EnvDTE;
using EnvDTE80;
using System.Windows.Forms;
public void OnConnection(object application, 
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    ToolBoxItemExample(_applicationObject);
}
public void ToolBoxItemExample(DTE2 dte)
{
    ToolBox tlBox;
    ToolBoxTabs tbxTabs;
    ToolBoxTab2 tbxTab;
    ToolBoxItem2 tbxItem;
    String aString = "All the toolbox items in the collection:" + "\n";
    // Before running this example, open a Windows Application project
    // and select Toolbox from the View menu.
    try
    {
        // Create an object reference to the IDE's ToolBox object
        // and its tabs.
        tlBox = (ToolBox)_applicationObject.Windows.Item
(Constants.vsWindowKindToolbox).Object;
        tbxTabs = tlBox.ToolBoxTabs;
        // Select the second Toolbox tab.
        tbxTab = (ToolBoxTab2)tbxTabs.Item(2);
        tbxTab.Activate();
        MessageBox.Show("Toolbox tab name: " + tbxTab.Name);
        tbxItem = (ToolBoxItem2)tbxTab.ToolBoxItems.Item(2);
        MessageBox.Show("ToolBox item name: " + tbxItem.Name);
        foreach (ToolBoxItem2 temp in tbxItem.Collection)
        {
            aString = aString + (temp.Name) + "\n";
        }
        MessageBox.Show(aString);
    }
    catch (Exception ex)
    {
        MessageBox.Show("ERROR: " + ex.Message);
    }
}

.NET Framework Security

See Also

Reference

ToolBoxItem2 Interface

EnvDTE80 Namespace