Reference (Interfaz)

Representa una referencia en el proyecto. La inclusión de una referencia en un proyecto permite usar cualquiera de los miembros públicos que contiene. Los proyectos pueden incluir referencias a otros proyectos .NET, ensamblados .NET y objetos COM.

Espacio de nombres: VSLangProj
Ensamblado: VSLangProj (en vslangproj.dll)

Sintaxis

'Declaración
<GuidAttribute("35D6FB50-35B6-4C81-B91C-3930B0D95386")> _
Public Interface Reference
'Uso
Dim instance As Reference

[GuidAttribute("35D6FB50-35B6-4C81-B91C-3930B0D95386")] 
public interface Reference

[GuidAttribute(L"35D6FB50-35B6-4C81-B91C-3930B0D95386")] 
public interface class Reference

/** @attribute GuidAttribute("35D6FB50-35B6-4C81-B91C-3930B0D95386") */ 
public interface Reference

GuidAttribute("35D6FB50-35B6-4C81-B91C-3930B0D95386") 
public interface Reference

Comentarios

Los objetos Reference están contenidos en la colección References del objeto VSProject. Hay dos tipos de objetos Reference: ensamblados (incluidos los proyectos de Visual Studio) y objetos COM. Cuando una referencia es otro proyecto, se denomina referencia entre proyectos y continúa considerándose como referencia de ensamblado.

Ejemplo

En el ejemplo siguiente se crea un nuevo proyecto a partir de una plantilla, se agregan dos referencias y se muestran sus tipos correspondientes.

'Macro Editor
Imports VSLangProj
Sub NewProject()
   Dim newName As String = InputBox("New project name:")
   ' Create a new project in the solution based on an existing
   ' project.
   Dim newProject As Project = DTE.Solution.AddFromTemplate( _
      "C:\TemplatePath\Template.vbproj", _
      "C:\ProjectPath\" & newName, newName)
        
   ' Add a COM reference and display its type.
   Dim vsProject As VSProject = CType(newProject.Object, VSProject)
   Dim newRef As Reference
   newRef = vsProject.References.Add("C:\WINNT\System32\msmask32.ocx")
   MsgBox(GetRefTypeName(newRef))
        
   ' Add an Assembly reference and display its type, "Assembly".
   newRef = vsProject.References.Add("C:\SomeProject\bin\SomeProject.dll")
   MsgBox(GetRefTypeName(newRef))
End Sub

Private Function GetRefTypeName(ByVal ref As Reference) _
   As String
   Dim type As String
   Select Case ref.Type
      Case prjReferenceType.prjReferenceTypeActiveX
         type = "COM"
      Case prjReferenceType.prjReferenceTypeAssembly
         type = "Assembly"
   End Select
   Return type
End Function

El ejemplo siguiente crea un breve informe con las propiedades de una referencia.

' Macro Editor
' Create a small report about a reference.
Imports VSLangProj
Function ReportReferences(ByVal aRef As Reference) As String
   Dim report As String = ""
   Dim type As String
   ' Each entry in the ArrayList will contain a label and a value.
   Dim ht As System.Collections.ArrayList = _
      New System.Collections.ArrayList()
   With aRef
      ht.Add(New String() {"Name", .Name})
      ht.Add(New String() {"Description", .Description})
      ht.Add(New String() {"Version", String.Format("{0}.{1}.{2}.{3}", _
         .MajorVersion, .MinorVersion, .BuildNumber, .RevisionNumber)})
      ht.Add(New String() {"Location", .ContainingProject.FullName})
      Select Case .Type
         Case prjReferenceType.prjReferenceTypeActiveX
            type = "COM"
         Case prjReferenceType.prjReferenceTypeAssembly
            type = "Assembly"
      End Select
      ht.Add(New String() {"Type", type})
      ht.Add(New String() {"Culture", .Culture})
   End With
        
   Dim datas() As String
   For Each datas In ht
      report &= datas(0) & ControlChars.Tab & datas(1) & ControlChars.CrLf
   Next
   Return report
End Function

Vea también

Referencia

Reference (Miembros)
VSLangProj (Espacio de nombres)