ToolBoxTab3 Interface

Definition

Namespace:

EnvDTE90

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public interface class ToolBoxTab3 : EnvDTE80::ToolBoxTab2

public interface class ToolBoxTab3 : EnvDTE80::ToolBoxTab2

__interface ToolBoxTab3 : EnvDTE80::ToolBoxTab2

[System.Runtime.InteropServices.Guid("09D8476F-E6BF-46FB-A0A9-61C331B90F06")]
public interface ToolBoxTab3 : EnvDTE80.ToolBoxTab2

[<System.Runtime.InteropServices.Guid("09D8476F-E6BF-46FB-A0A9-61C331B90F06")>]
type ToolBoxTab3 = interface
    interface ToolBoxTab2
    interface ToolBoxTab

Public Interface ToolBoxTab3
Implements ToolBoxTab2

Attributes

GuidAttribute

Implements

ToolBoxTab ToolBoxTab2

Examples

This example selects and activates the first ToolBoxTab3 item and displays its name in a message box.

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

Properties

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.

Methods

Activate()	Moves the focus to the current item.
Delete()	Removes the ToolBoxTab3 from a collection.