CodeClass.Collection Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets a CodeElements collection.

public:
 property EnvDTE::CodeElements ^ Collection { EnvDTE::CodeElements ^ get(); };

[System.Runtime.InteropServices.DispId(2)]
public EnvDTE.CodeElements Collection { [System.Runtime.InteropServices.DispId(2)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; }

[<System.Runtime.InteropServices.DispId(2)>]
[<get: System.Runtime.InteropServices.DispId(2)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Collection : EnvDTE.CodeElements

Public ReadOnly Property Collection As CodeElements

Property Value

CodeElements

A CodeElements collection.

Attributes

DispIdAttribute TypeLibFuncAttribute

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);  
    }  
}  

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).