ToolBoxTab2 Interface

Represents a tab in the Toolbox, along with any objects the tab contains.

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

Syntax

'Declaration
<GuidAttribute("A64715CB-85D7-41C3-8E71-2302D4EEBC34")> _
Public Interface ToolBoxTab2 _
    Inherits ToolBoxTab

[GuidAttribute("A64715CB-85D7-41C3-8E71-2302D4EEBC34")]
public interface ToolBoxTab2 : ToolBoxTab

[GuidAttribute(L"A64715CB-85D7-41C3-8E71-2302D4EEBC34")]
public interface class ToolBoxTab2 : ToolBoxTab

[<GuidAttribute("A64715CB-85D7-41C3-8E71-2302D4EEBC34")>]
type ToolBoxTab2 =  
    interface
        interface ToolBoxTab
    end

public interface ToolBoxTab2 extends ToolBoxTab

The ToolBoxTab2 type exposes the following members.

Properties

	Name	Description
	Collection	Gets the collection containing the ToolBoxTab object supporting this property.
	DTE	Gets the top-level extensibility object.
	ListView	Gets or sets a value indicating whether items in a particular ToolBox tab display in List view or Icon view format.
	Name	Gets or sets the name of the ToolBoxTab2 object.
	ToolBoxItems	Gets the collection of ToolBoxItems associated with a ToolBoxTab.
	UniqueID	Sets or gets a unique ID for the specified tab.

Top

Methods

	Name	Description
	Activate	Moves the focus to the current item.
	Delete	Removes the ToolBoxTab from a collection.

Top

Examples

This example selects and activates the first ToolBoxTab2 item and displays its name in a message box. 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)
    ToolBoxTabExample(_applicationObject)
End Sub
Sub ToolBoxTabExample(ByVal dte As DTE2)
    Dim tlBox As ToolBox
    Dim tbxTabs As ToolBoxTabs
    Dim tbxTab As ToolBoxTab2
    Dim tbxItem As ToolBoxItem
    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()
        tbxItem = tbxTab.ToolBoxItems.Item(1)
        MsgBox("Toolbox item name: " & tbxItem.Name)
    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;
    ToolBoxTabExample(_applicationObject);
}
public void ToolBoxTabExample(DTE2 dte)
{
    ToolBox tlBox;
    ToolBoxTabs tbxTabs;
    ToolBoxTab2 tbxTab;
    ToolBoxItem tbxItem;
    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 first Toolbox tab is: " 
+ tbxTab.Name);
        tbxTab.Activate();
        tbxItem = tbxTab.ToolBoxItems.Item(1);
        MessageBox.Show("Toolbox item name: " + tbxItem.Name);
    }
    catch (Exception ex)
    {
        MessageBox.Show("ERROR: " + ex.Message);
    }
}

See Also

Reference

EnvDTE80 Namespace