CodeEvent.Children Property

Gets a collection of objects contained within this CodeEvent.

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

Syntax

'Declaration
ReadOnly Property Children As CodeElements

CodeElements Children { get; }

property CodeElements^ Children {
    CodeElements^ get ();
}

abstract Children : CodeElements with get

function get Children () : CodeElements

Property Value

Type: EnvDTE.CodeElements
A CodeElements collection.

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. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Examples

The following example demonstrates how to use the Children property.

To test this property:

1. Open the target project and select the code event element by placing the cursor on the event object.

2. Run the add-in.

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

.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

CodeEvent Interface

EnvDTE80 Namespace

Children

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