CodeClass.Collection Property

Gets a CodeElements collection.

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

Syntax

'Declaration
ReadOnly Property Collection As CodeElements
CodeElements Collection { get; }
property CodeElements^ Collection {
    CodeElements^ get ();
}
abstract Collection : CodeElements with get
function get Collection () : CodeElements

Property Value

Type: EnvDTE.CodeElements
A CodeElements collection.

Remarks

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

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

See Also

Reference

CodeClass Interface

EnvDTE Namespace

Other Resources

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

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)