ToolBoxTab3 Interface

Represents a tab in the Toolbox, along with any objects the tab contains. ToolBoxTab3 supersedes the ToolBoxTab and ToolBoxTab2 interfaces.

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

Syntax

'Declaration
<GuidAttribute("09D8476F-E6BF-46FB-A0A9-61C331B90F06")> _
Public Interface ToolBoxTab3 _
    Inherits ToolBoxTab2

[GuidAttribute("09D8476F-E6BF-46FB-A0A9-61C331B90F06")]
public interface ToolBoxTab3 : ToolBoxTab2

[GuidAttribute(L"09D8476F-E6BF-46FB-A0A9-61C331B90F06")]
public interface class ToolBoxTab3 : ToolBoxTab2

[<GuidAttribute("09D8476F-E6BF-46FB-A0A9-61C331B90F06")>]
type ToolBoxTab3 =  
    interface 
        interface ToolBoxTab2 
    end

public interface ToolBoxTab3 extends ToolBoxTab2

The ToolBoxTab3 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.
	Expanded	Gets or sets whether the Toolbox tab is displayed or rolled up.
	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 ToolBoxTab3 object.
	ToolBoxItems	Gets the collection of ToolBoxItems associated with a ToolBoxTab3.
	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 ToolBoxTab3 from a collection.

Top

Examples

This example selects and activates the first ToolBoxTab3 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
Imports EnvDTE90
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 ToolBoxTab3
    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), ToolBoxTab3)
        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 EnvDTE90;
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;
    ToolBoxTab3 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 = (ToolBoxTab3)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

EnvDTE90 Namespace