ToolBoxItem2 Interface

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Represents an item in the Toolbox.

public interface class ToolBoxItem2 : EnvDTE::ToolBoxItem

public interface class ToolBoxItem2 : EnvDTE::ToolBoxItem

__interface ToolBoxItem2 : EnvDTE::ToolBoxItem

[System.Runtime.InteropServices.Guid("82C9DBF2-1DA8-4ED6-A5EC-8B876B46317C")]
public interface ToolBoxItem2 : EnvDTE.ToolBoxItem

[<System.Runtime.InteropServices.Guid("82C9DBF2-1DA8-4ED6-A5EC-8B876B46317C")>]
type ToolBoxItem2 = interface
    interface ToolBoxItem

Public Interface ToolBoxItem2
Implements ToolBoxItem

Attributes

GuidAttribute

Implements

ToolBoxItem

Examples

This example selects the second ToolBoxItem2 item and displays its name in a message box.

Imports EnvDTE  
Imports EnvDTE80  
Sub ToolBoxItemExample(ByVal dte As DTE2)  
    Dim tlBox As ToolBox  
    Dim tbxTabs As ToolBoxTabs  
    Dim tbxTab As ToolBoxTab2  
    Dim tbxItem As ToolBoxItem2  
    ' Before running this example, open a Windows Application project.  
    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 second ToolBox tab.  
        tbxTab = CType(tbxTabs.Item(2), ToolBoxTab2)  
        tbxTab.Activate()  
        MsgBox("Toolbox tab name: " & tbxTab.Name)  
        tbxItem = CType(tbxTab.ToolBoxItems.Item(2), ToolBoxItem2)  
        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 ToolBoxItemExample(DTE2 dte)  
{  
    ToolBox tlBox;  
    ToolBoxTabs tbxTabs;  
    ToolBoxTab2 tbxTab;  
    ToolBoxItem2 tbxItem;  
    // Before running this example, open a Windows Application project,  
    // and select Toolbox from the View menu.  
    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 second Toolbox tab.  
        tbxTab = (ToolBoxTab2)tbxTabs.Item(2);  
        tbxTab.Activate();  
        MessageBox.Show("Toolbox tab name: " + tbxTab.Name);  
        tbxItem = (ToolBoxItem2)tbxTab.ToolBoxItems.Item(2);  
        MessageBox.Show("ToolBox item name: " + tbxItem.Name);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show("ERROR: " + ex.Message);  
    }  
}  

Remarks

A ToolBoxItem object can contain controls, text fragments, HTML fragments, or other objects that you can insert.

Properties

Collection	Gets the collection containing the ToolBoxItem object supporting this property.
Data	Gets an object containing the IDataObject of the ToolBoxItem on the tool box.
DTE	Gets the top-level extensibility object.
Name	Gets or sets the name of the ToolBoxItem object.

Methods

Delete()	Removes the ToolBoxItem object from the collection.
Select()	Causes this item to become active in the integrated development environment (IDE).