Reference3.Description, propriété

Article
05/16/2015

Obtient un texte de description de la référence.

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

Syntaxe

'Déclaration
ReadOnly Property Description As String

string Description { get; }

property String^ Description {
    String^ get ();
}

abstract Description : string with get

function get Description () : String

Valeur de propriété

Type : String
Pour un objet Reference, la valeur de retour dépend du type référence.

Type référence	Valeur de retour
Assembly	Description de l'assembly.
COM	Description de la bibliothèque de types.

Notes

Les propriétés Description et Name d'une référence diffèrent dans leur fonction et dans leur longueur. La propriété Name, par exemple System.Windows.Forms, doit être descriptive mais concise. La propriété Description peut être plus longue et contenir des informations plus détaillées. Elle a la même fonction qu'une description de bibliothèque de types COM.

La propriété Description est enregistrée dans l'assembly en tant qu'attribut personnalisé, contrairement à la plupart des autres propriétés exposées par l'objet Reference, qui sont enregistrées dans les métadonnées.

Vous pouvez modifier cette propriété en lecture seule dans l'environnement de développement en modifiant les attributs personnalisés dans le fichier AssemblyInfo.vb (pour les projets Visual Basic) ou le fichier AssemblyInfo.cs (pour les projets Visual C#).

Exemples

Cet exemple affiche les chaînes Description pour toutes les références d'un projet Visual Basic ou Visual C# ouvert. Pour exécuter cet exemple comme un complément, consultez Comment : compiler et exécuter les exemples de code du modèle objet Automation.

Imports VSLangProj
Imports VSLangProj2
Imports VSLangProj80
Public Sub OnConnection(ByVal application As Object,_
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    applicationObject = CType(application, DTE2)
    addInInstance = CType(addInInst, AddIn)
    DisplayDescriptions(applicationObject)
End Sub
Public Sub DisplayDescriptions(ByVal dte As DTE2)
    ' The first project is a Visual Basic or C# project.
    Dim vsProject As VSProject2 = _
    CType(applicationObject.Solution.Projects.Item(1).Object, _
    VSProject2)
    Dim aRef As Reference3
    Dim refStr As String
    refStr = ""
    For Each aRef In vsProject.References
        refStr += (aRef.Name & "'s description is:  " _
        & aRef.Description.ToString() & vbCr & vbCr)
    Next
    MsgBox(refStr)
End Sub

using System.Windows.Forms;
using VSLangProj;
using VSLangProj2;
using VSLangProj80;
public void OnConnection(object application,
 ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    applicationObject = (DTE2)application;
    addInInstance = (AddIn)addInInst;
    DisplayDescriptions(((DTE2)applicationObject));
}
public void DisplayDescriptions(DTE2 dte)
{
    // The first project is a Visual Basic or C# project.
    VSProject2 vsProject = ((VSProject2)
 (applicationObject.Solution.Projects.Item(1).Object));
    Reference aRef = null;
    string refStr = null;
    foreach (VSLangProj80.Reference3 temp in vsProject.References)
    {
        aRef = temp;
        refStr += (aRef.Name + "'s Description is:   " 
+ aRef.Description.ToString() + "\n" + "\n");
    }
    MessageBox.Show(refStr);
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

Reference3 Interface

VSLangProj80, espace de noms

Partager via