Reference3.Description-Eigenschaft

Ruft eine Textbeschreibung des Verweises ab.

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

Syntax

'Declaration
ReadOnly Property Description As String

string Description { get; }

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

abstract Description : string

function get Description () : String

Eigenschaftswert

Typ: System.String
Bei einem Reference-Objekt richtet sich der Rückgabewert nach dem Verweistyp.

Hinweise

Bei der Description-Eigenschaft und Name-Eigenschaft eines Verweises sind Zweck und Länge verschieden.Die Name-Eigenschaft, z. B. System.Windows.Forms, soll aussagekräftig und doch kurz sein.Die Description-Eigenschaft kann länger sein und detailliertere Informationen enthalten.Sie hat die gleiche Funktion wie die Beschreibung der COM-Typbibliotheken.

Die Description-Eigenschaft wird als benutzerdefiniertes Attribut in der Assembly gespeichert.Dies ist anders als bei den meisten anderen Eigenschaften, die vom Reference-Objekt verfügbar gemacht und in den Metadaten gespeichert werden.

Diese schreibgeschützte Eigenschaft kann in der Entwicklungsumgebung geändert werden, indem die benutzerdefinierten Attribute in der Datei AssemblyInfo.vb (Visual Basic-Projekte) oder AssemblyInfo.cs (Visual C#-Projekte) bearbeitet werden.

Beispiele

In diesem Beispiel werden die Description-Zeichenfolgen für alle Verweise in einem geöffneten Visual Basic- oder Visual C#-Projekt angezeigt.Um dieses Beispiel als Add-In auszuführen, informieren Sie sich unter Gewusst wie: Kompilieren und Ausführen der Codebeispiele für das Automatisierungsobjektmodell.

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);
}

.NET Framework-Sicherheit

• Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

Reference3 Schnittstelle

Description-Überladung

VSLangProj80-Namespace