References.Item Method

Article
02/23/2011

Returns an indexed Reference object.

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

Syntax

'Declaration
Function Item ( _
    index As Object _
) As Reference

Reference Item(
    Object index
)

Reference^ Item(
    [InAttribute] Object^ index
)

abstract Item : 
        index:Object -> Reference

function Item(
    index : Object
) : Reference

Parameters

index
Type: System.Object
Required. Either the Identity string of the Reference object or a one-based index into the References collection.

Return Value

Type: VSLangProj.Reference
Returns a Reference object.

Remarks

This method is used to retrieve a specific object from the References collection. There is no guarantee that a given index number for a collection will always point to the same item, because items may be added or deleted from the collection. Using index numbers for the collection is useful when iterating through the whole collection and no items are added or deleted during the iteration.

Examples

' Macro Editor
Imports VSLangProj
Public Sub FindExample()
   ' First project is a Visual Basic or C# project.
   Dim theVSProject As VSProject = _
      CType(DTE.Solution.Projects.Item(1).Object, VSProject)
        
   Dim refs As References = theVSProject.References
   Dim firstIdentity As String = refs.Item(1).Identity
   Dim firstRef As Reference = refs.Find(firstIdentity)
   ' Are they the same object?
   Dim isSame As Boolean = (firstRef.Identity = refs.Item(1).Identity)
   MsgBox("Are they the same? " & isSame.ToString())
End Sub

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

Share via