ToolBoxTab2.Collection Property

  • Article

Gets the collection containing the ToolBoxTab object supporting this property.

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

Syntax

'Declaration
ReadOnly Property Collection As ToolBoxTabs

ToolBoxTabs Collection { get; }

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

abstract Collection : ToolBoxTabs

function get Collection () : ToolBoxTabs

Property Value

Type: EnvDTE.ToolBoxTabs
A ToolBoxTabs collection.

Implements

ToolBoxTab.Collection

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. 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)
    ToolBoxTabCollectionExample(_applicationObject)
End Sub
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 OnConnection(object application, 
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    ToolBoxTabCollectionExample(_applicationObject);
}
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);
    }
}

.NET Framework Security

See Also

Reference

ToolBoxTab2 Interface

EnvDTE80 Namespace