Reference, interface

Article
08/10/2011

Cet objet représente une référence du projet. Le fait d'inclure une référence dans un projet vous permet d'utiliser tout membre public qu'elle contient. Les projets peuvent inclure des références à d'autres projets ou assemblys .NET et à des objets COM.

Espace de noms : VSLangProj
Assembly : VSLangProj (dans VSLangProj.dll)

Syntaxe

'Déclaration
<GuidAttribute("35D6FB50-35B6-4C81-B91C-3930B0D95386")> _
Public Interface Reference

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

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

[<GuidAttribute("35D6FB50-35B6-4C81-B91C-3930B0D95386")>]
type Reference =  interface end

public interface Reference

Le type Reference expose les membres suivants.

Propriétés

	Nom	Description
	BuildNumber	Obtient le numéro de build de la référence.En lecture seule.
	Collection	Obtient la collection contenant l'objet qui prend en charge cette propriété ou qui est contenu dans cette construction de code.
	ContainingProject	Obtient le projet dont fait partie l'élément sélectionné.En lecture seule.
	CopyLocal	Détermine si la référence est copiée dans le chemin bin local.
	Culture	Obtient la chaîne Culture d'une référence.En lecture seule.
	Description	Obtient un texte de description de la référence.En lecture seule.
	DTE	Obtient l'objet d'extensibilité de niveau supérieur.
	Extender	Obtient l'objet Extender demandé s'il est disponible pour cet objet.
	ExtenderCATID	Obtient l'identificateur de catégorie (CATID) d'extendeur de l'objet.
	ExtenderNames	Obtient la liste des extendeurs disponibles pour l'objet.
	Identity	Obtient l'identificateur unique de la référence.En lecture seule.
	MajorVersion	Retourne le numéro de version majeure de la référence.En lecture seule.
	MinorVersion	Obtient le numéro de version mineure de la référence.En lecture seule.
	Name	Obtient le nom de l'objet.En lecture seule.
	Path	Obtient le chemin d'accès au fichier de référence.En lecture seule.
	PublicKeyToken	Obtient le jeton de clé publique de l'assembly référencé.
	RevisionNumber	Obtient le numéro de révision de la référence.En lecture seule.
	SourceProject	Obtient un objet Project si la référence est un projet.Sinon, retourne Nothing (référence nullune référence null (Nothing en Visual Basic)).En lecture seule.
	StrongName	Obtient une valeur indiquant si la référence est signée à l'aide d'une paire de clés publique/privée.En lecture seule.
	Type	Obtient une valeur prjReferenceType indiquant si une référence est un assembly ou un composant COM.En lecture seule.
	Version	Obtient la version de la référence sélectionnée.

Début

Méthodes

	Nom	Description
	Remove	Obtient la référence de l'objet References qui la contient.

Début

Notes

Les objets Reference sont contenus dans la collection References de l'objet VSProject. Les objets Reference sont de deux types : assemblys (y compris les projets Visual Studio .NET) et objets COM. Une référence à un autre projet (appelée « référence projet-à-projet ») reste considérée comme une référence d'assembly.

Exemples

L'exemple suivant crée un nouveau projet à partir d'un modèle, ajoute deux références et affiche leurs types.

'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

L'exemple suivant crée un court rapport des propriétés d'une référence.

' 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

Voir aussi

Référence

VSLangProj, espace de noms

Partager via