ToolBoxItem2.Collection Property

  • Reference

Definition

Namespace:
EnvDTE80
Assembly:
EnvDTE80.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Gets the collection containing the ToolBoxItem object supporting this property.

public:
 property EnvDTE::ToolBoxItems ^ Collection { EnvDTE::ToolBoxItems ^ get(); };
[System.Runtime.InteropServices.DispId(1)]
public EnvDTE.ToolBoxItems Collection { [System.Runtime.InteropServices.DispId(1)] get; }
[<System.Runtime.InteropServices.DispId(1)>]
[<get: System.Runtime.InteropServices.DispId(1)>]
member this.Collection : EnvDTE.ToolBoxItems
Public ReadOnly Property Collection As ToolBoxItems

Property Value

ToolBoxItems

A ToolBoxItems collection.

Implements

Collection
Attributes
DispIdAttribute

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.

Imports EnvDTE  
Imports EnvDTE80  
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 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);  
    }  
}

Applies to