VSProject.References Property

Reference

Definition

Namespace:: VSLangProj

Assembly:: VSLangProj.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 the References collection for the project. Read-only.

public:
 property VSLangProj::References ^ References { VSLangProj::References ^ get(); };

[System.Runtime.InteropServices.DispId(1)]
public VSLangProj.References References { [System.Runtime.InteropServices.DispId(1)] get; }

[<System.Runtime.InteropServices.DispId(1)>]
[<get: System.Runtime.InteropServices.DispId(1)>]
member this.References : VSLangProj.References

Public ReadOnly Property References As References

Property Value

References

A References collection containing Reference objects, each one representing a reference.

Attributes: DispIdAttribute

Examples

[Visual Basic]

' Macro Editor  
' Assuming that the first project in the solution is a Visual Basic or C#  
' application, this routine lists the references in the project.  
Imports VSLangProj  
Sub ListReferences()  
   ' Retrieve the VSProject object.  
   Dim theVSProject As VSProject = _  
      CType(DTE.Solution.Projects.Item(1).Object, VSProject)  

   ' Retrieve the references collection.  
   Dim refs As References = theVSProject.References  

   ' Create a string list of the reference names.  
   Dim refList As String = ""  
   Dim aRef As Reference  
   For Each aRef In refs  
      refList &= aRef.Identity & ControlChars.CrLf  
   Next  
   MsgBox(refList)  
End Sub

Remarks

In order to write code against an external component, your project must first contain a reference to that component. A reference can be made to three types of components: .NET assemblies, COM automation servers and controls, and other projects within the same solution that expose components.

Applies to

Share via