ToolBoxTab.Collection Property

Gets the collection containing the ToolBoxTab object supporting this property.

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

Syntax

'Declaration
ReadOnly Property Collection As ToolBoxTabs

ToolBoxTabs Collection { get; }

property ToolBoxTabs^ Collection {
    ToolBoxTabs^ get ();
}

abstract Collection : ToolBoxTabs with get

function get Collection () : ToolBoxTabs

Property Value

Type: EnvDTE.ToolBoxTabs
A ToolBoxTabs collection.

Examples

Sub CollectionExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a class definition.
    Try
        ' Retrieve the CodeClass at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)
        Dim elem As CodeElement
        Dim peers As String

        ' List all peer elements of the CodeClass.
        For Each elem In cls.Collection
            If Not (elem Is cls) And Not IsNothing(elem.Name) Then
                peers &= elem.Name & " (" & elem.Kind.ToString() & _
                    ")" & vbCrLf
            End If
        Next

        MsgBox(cls.Name & " has the following peer elements:" & _
            vbCrLf & vbCrLf & peers)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void CollectionExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);
        string peers = "";

        // List all peer elements of the CodeClass.
        foreach (CodeElement elem in cls.Collection)
        {
            if ((elem != cls) && (elem.Name != null))
                peers += elem.Name + " (" + elem.Kind.ToString() 
                    + ")\n";
        }

        MessageBox.Show(cls.Name + 
            " has the following peer elements:\n\n" + peers);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

ToolBoxTab Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples