ToolBoxItems Interface

Contains all items in a ToolBox tab.

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

Syntax

'Declaration
<GuidAttribute("395C7DFB-F158-431C-8F43-DDA83B4EF54E")> _
Public Interface ToolBoxItems _
    Inherits IEnumerable

[GuidAttribute("395C7DFB-F158-431C-8F43-DDA83B4EF54E")]
public interface ToolBoxItems : IEnumerable

[GuidAttribute(L"395C7DFB-F158-431C-8F43-DDA83B4EF54E")]
public interface class ToolBoxItems : IEnumerable

[<GuidAttribute("395C7DFB-F158-431C-8F43-DDA83B4EF54E")>]
type ToolBoxItems =  
    interface
        interface IEnumerable
    end

public interface ToolBoxItems extends IEnumerable

The ToolBoxItems type exposes the following members.

Properties

	Name	Description
	Count	Gets a value indicating the number of objects in the ToolBoxItems collection.
	DTE	Gets the top-level extensibility object.
	Parent	Gets the immediate parent object of a ToolBoxItems object.
	SelectedItem	Gets the item currently selected in the tab of the ToolBox, if any exist.

Top

Methods

	Name	Description
	Add	Creates a new item and adds it to the ToolBox.
	GetEnumerator	Gets an enumerator for items in the collection.
	Item	Returns a ToolBoxItem object in a ToolBoxItems collection.

Top

Remarks

The default property of the ToolBoxItems collection is Item, which can be indexed either by name or by ordinal number.

Examples

Sub ToolBoxItemsExample()
    Dim tlBox As ToolBox
    Dim tbxTabs As ToolBoxTabs
    Dim tbxTab As ToolBoxTab
    Dim tbxItems As ToolBoxItems

    Try
        ' Create an object reference to the IDE's ToolBox object and
        ' its tabs.
        tlBox = DTE.Windows.Item(Constants.vsWindowKindToolbox).Object
        tbxTabs = tlBox.ToolBoxTabs

        ' Add a new tab to the ToolBox and select it.
        tbxTab = tbxTabs.Add("New ToolBox Tab")
        tbxTab.Activate()

        ' Add new items to the new ToolBox tab. This shows two
        ' different ways to index the ToolBox tabs. The third item
        ' added is a .NET component that contains a number of 
        ' Web-related controls.
        tbxTab.ToolBoxItems.Add("Text Item", "Hello world")
        tbxTab.ToolBoxItems.Add("HTML Item", "Hello world", _
        vsToolBoxItemFormat.vsToolBoxItemFormatHTML)
        tbxTabs.Item("New ToolBox Tab").ToolBoxItems.Add("DotNET _
        Component", "C:\WINNT\Microsoft.NET\Framework\v1.1.4322 _
        \System.Web.dll", vsToolBoxItemFormat. _
        vsToolBoxItemFormatDotNETComponent)

        ' Use the ToolboxItems collection to access all the items under 
        ' a ToolBox tab.
        tbxItems = tbxTab.ToolBoxItems

        ' List number of ToolboxItems in a ToolBoxTab.
        MsgBox("Number of items in " & tbxTabs.Item(1).Name & " tab: _
        " & tbxItems.Count)

        ' Select the second item in the ToolboxItems collection and 
        ' delete it.
        tbxItems.Item(2).Select()
        If (MsgBox("Delete second ToolBox item?", vbYesNo) = vbYes) _
        Then
            tbxItems.SelectedItem.Delete()
            MsgBox("Number of items in " & tbxTabs.Item(1).Name & " _
            tab: " & tbxItems.Count)
        End If
    Catch ex As System.Exception
        MsgBox("ERROR: " & ex.Message)
    End Try
End Sub

See Also

Reference

EnvDTE Namespace

Other Resources

How to: Control the Toolbox