CodeEvent.Children Property

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a collection of objects contained within this CodeEvent.

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.

Attributes: DispIdAttribute TypeLibFuncAttribute

Examples

The following example demonstrates how to use the Children property.

public static void Children(EnvDTE80.DTE2 dte)  
{  
    TextSelection objTextSel;  
    EnvDTE80.CodeEvent codeEvent;  
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;  
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);  

    MessageBox.Show("\nNumber of Children: " +  
        codeEvent.Children.Count, "Testing Children Property");  
}

Remarks

If a CodeEvent object has no children, then Nothing 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.

Children returns the collection of all related CodeElement objects that can be referenced via this code element. For example, for a CodeClass, 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. A CodeFunction might include all of its parameters, contributed parameters based on the Attributed Programming feature in Visual C++, 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.

Applies to

Share via