Reference3.Description 属性

项目
10/25/2012

获取引用的文本说明。

命名空间： VSLangProj80
程序集： VSLangProj80（在 VSLangProj80.dll 中）

语法

声明
ReadOnly Property Description As String

string Description { get; }

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

abstract Description : string

function get Description () : String

属性值

类型：System.String
对于 Reference 对象，返回值取决于引用类型。

引用类型	返回的值
程序集	程序集说明。
COM	类型库说明。

备注

引用的 Description 属性和 Name 属性在用途和长度上有所不同。Name 属性（例如 System.Windows.Forms）应具有描述性且简短。Description 属性可以较长，并包含更详细的信息。其功能与 COM 类型库说明相同。

Description 属性作为自定义特性存储在程序集中。这与 Reference 对象公开的大多数其他属性不同，后者存储在元数据中。

在开发环境中，通过编辑 AssemblyInfo.vb 文件（对于 Visual Basic 项目）、AssemblyInfo.cs 文件（Visual C# 项目）中的自定义特性，可以更改此只读属性。

示例

此示例显示打开的 Visual Basic 或 Visual C# 项目中所有引用的 Description 字符串。若要将此示例作为外接程序运行，请参见如何：编译和运行自动化对象模型代码示例。

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