Partager via


ToolBoxItems Interface

Definition

Contains all items in a ToolBox tab.

public interface class ToolBoxItems : System::Collections::IEnumerable
[System.Runtime.InteropServices.Guid("395C7DFB-F158-431C-8F43-DDA83B4EF54E")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface ToolBoxItems : System.Collections.IEnumerable
[System.Runtime.InteropServices.Guid("395C7DFB-F158-431C-8F43-DDA83B4EF54E")]
public interface ToolBoxItems : System.Collections.IEnumerable
[<System.Runtime.InteropServices.Guid("395C7DFB-F158-431C-8F43-DDA83B4EF54E")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type ToolBoxItems = interface
    interface IEnumerable
[<System.Runtime.InteropServices.Guid("395C7DFB-F158-431C-8F43-DDA83B4EF54E")>]
type ToolBoxItems = interface
    interface IEnumerable
Public Interface ToolBoxItems
Implements IEnumerable
Attributes
Implements

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  

Remarks

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

Properties

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.

Methods

Add(String, Object, vsToolBoxItemFormat)

Creates a new item and adds it to the ToolBox.

GetEnumerator()

Gets an enumerator for items in the collection.

Item(Object)

Returns a ToolBoxItem object in a ToolBoxItems collection.

Applies to