ToolBoxTab2.Collection Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the collection containing the ToolBoxTab object supporting this property.

public:
 property EnvDTE::ToolBoxTabs ^ Collection { EnvDTE::ToolBoxTabs ^ get(); };

[System.Runtime.InteropServices.DispId(1)]
public EnvDTE.ToolBoxTabs Collection { [System.Runtime.InteropServices.DispId(1)] get; }

[<System.Runtime.InteropServices.DispId(1)>]
[<get: System.Runtime.InteropServices.DispId(1)>]
member this.Collection : EnvDTE.ToolBoxTabs

Public ReadOnly Property Collection As ToolBoxTabs

Property Value

ToolBoxTabs

A ToolBoxTabs collection.

Implements

Collection

Attributes

DispIdAttribute

Examples

This example selects and activates the first ToolBoxTab2 item and displays its name in a message box. The example then adds a new tab, MyNewTab, to the ToolBoxTab2 collection, displays the names of the first two items in the collection, and deletes MyNewTab.

Imports EnvDTE  
Imports EnvDTE80  
Sub ToolBoxTabCollectionExample(ByVal dte As DTE2)  
    Dim tlBox As ToolBox  
    Dim tbxTabs As ToolBoxTabs  
    Dim tbxTab As ToolBoxTab2  
    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 first Toolbox tab.  
        tbxTab = CType(tbxTabs.Item(1), ToolBoxTab2)  
        MsgBox(tbxTab.Name)  
        tbxTab.Activate()  
        tbxTab.Collection.Add("MyNewTab")  
        MsgBox("The number of items in the Toolboxtab collection: "  _  
        & tbxTab.Collection.Count)  
        MsgBox("The name of the first item in the collection: "  _  
        & tbxTab.Collection.Item(1).Name)  
        MsgBox("The name of the second item in the collection: "  _  
        & tbxTab.Collection.Item(2).Name)  
        ' Delete the tab you added.  
        tbxTab.Collection.Item("MyNewTab").Delete()  
    Catch ex As System.Exception  
        MsgBox("ERROR: " & ex.Message)  
    End Try  
End Sub  

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void ToolBoxTabCollectionExample(DTE2 dte)  
{  
    ToolBox tlBox;  
    ToolBoxTabs tbxTabs;  
    ToolBoxTab2 tbxTab;  
    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 first Toolbox tab.  
        tbxTab = (ToolBoxTab2)tbxTabs.Item(1);  
        MessageBox.Show("The name of the selected Toolbox tab is: "   
+ tbxTab.Name);  
        tbxTab.Activate();  
        // Add a new tab to the collection.  
        tbxTab.Collection.Add("MyNewTab");  
        MessageBox.Show("The number of items in the Toolboxtab  
 collection: " + tbxTab.Collection.Count);  
        MessageBox.Show("The name of the first item in the collection:  
 " + tbxTab.Collection.Item(1).Name);  
        MessageBox.Show("The name of the second item in the collection:  
 " + tbxTab.Collection.Item(2).Name);  
        // Delete the tab you added.  
        tbxTab.Collection.Item("MyNewTab").Delete();  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show("ERROR: " + ex.Message);  
    }  
}