Reference.Collection Property

Gets the collection containing the object supporting this property or contained within this code construct.

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

Syntax

'Declaration
ReadOnly Property Collection As References
References Collection { get; }
property References^ Collection {
    References^ get ();
}
abstract Collection : References with get
function get Collection () : References

Property Value

Type: VSLangProj.References
Returns a collection relating to the object. See Remarks for more information.

Remarks

<CollectionName> in the syntax refers to the appropriate collection name that relates to the object. For example, <CollectionName> for the TextRange object would be TextRanges. <CollectionName> for the ToolBoxTab object would be ToolBoxTabs. In general, the collection name is a plural form of the object name.

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

.NET Framework Security

See Also

Reference

Reference Interface

VSLangProj Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples