Share via

CodeEvent.Collection Property

  • Article

Gets a CodeElements collection.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.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

This property gets a primary CodeElements collection containing the CodeElement objects. If a CodeElement is a class member, the primary collection is the Members collection. For classes, the primary collection is CodeElements, Members, or Members.

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 Collection 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 Collection(EnvDTE80.DTE2 dte)
{

    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    string str = "";
    foreach (CodeElement ce in codeEvent.Collection)
        str += "\n" + ce.Name;
    MessageBox.Show("\nCollection property: " +
                    str, "Testing CodeEvent");
}

.NET Framework Security

See Also

Reference

CodeEvent Interface

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