CodeClass2.Children Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets a collection of objects contained within this code class.

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

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

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

Public ReadOnly Property Children As CodeElements

Property Value

CodeElements

A CodeElements collection.

Implements

Children

Attributes

DispIdAttribute TypeLibFuncAttribute

Examples

[Visual Basic]

Sub ChildrenExample(ByVal dte As DTE2)  
    ' Before running this example, open a code document from a project  
    ' and place the insertion point inside a namespace definition.  
    Try  
        ' Retrieve the CodeNamespace at the insertion point.  
        Dim sel As TextSelection = _  
            CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim spc As CodeNamespace = _  
            CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementNamespace), CodeNamespace)  

        ' Find the namespace's children.  
        Dim children As String  
        Dim elem As CodeElement  
        For Each elem In spc.Children  
            children &= elem.Name & vbCrLf  
        Next  

        MsgBox(spc.Name & " has the following child code elements:" & _  
            vbCrLf & vbCrLf & children)  
    Catch ex As Exception  
        MsgBox(ex.Message)  
    End Try  
End Sub  

[C#]

public void ChildrenExample(DTE2 dte)  
{  
    // Before running this example, open a code document from a project  
    // and place the insertion point inside a namespace definition.  
    try  
    {  
        // Retrieve the CodeNamespace at the insertion point.  
        TextSelection sel =   
            (TextSelection)dte.ActiveDocument.Selection;  
        CodeNamespace spc =   
            (CodeNamespace)sel.ActivePoint.get_CodeElement(  
            vsCMElement.vsCMElementNamespace);  

        // Find the namespace's children.  
        string children = "";  

        foreach (CodeElement elem in spc.Children)  
        children += elem.Name + "\r\n";  

        MessageBox.Show(spc.Name +   
            " has the following child code elements:" + "\r\n\r\n" +   
            children);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

Remarks

If the code class has no children, then Nothing or null is returned.

This property is used primarily by Visual C++. Children returns every object returnable from a code element. A class, for example, returns members, bases, implemented interfaces, attributes, comments, and so forth.

To iterate through the members of a namespace or type (class, struct, interface, and so forth), you must query interface (QI) or cast the CodeElement to a CodeNamespace and then use the Members property.

Children returns the collection of all related CodeElement objects that can be referenced via the code class. For example, this might include the metadata code elements for the class and perhaps the Visual C++ declspecs, along with contributed code based on the Attributed Programming feature in Visual C++, template parameters, and so forth.

The Children property may return Nothing depending on the object and the language. There is no requirement to support this in Visual Studio.

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