Reference3.Description 屬性

發行項
10/31/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 物件，則傳回值將視參考型別而定。

參考型別	傳回值
Assembly	組件描述。
COM	型別程式庫描述。

備註

參考的 Description 屬性和 Name 屬性兩者的用途和長度都不相同。例如，Name 屬性 System.Windows.Forms 是故意設計成比較簡短的描述。Description 屬性可能就比較長，而且含有更詳細的資訊。它和 COM 型別程式庫描述具有相同的功能。

Description 屬性 (property) 在組件中儲存為自訂屬性 (attribute)。這和 Reference 物件公開的大部分其他屬性不同，後者都是存放在中繼資料內。

藉由在 AssemblyInfo.vb 檔 (Visual Basic 專案) 或 AssemblyInfo.cs 檔 (Visual C# 專案) 中編輯自訂屬性 (Attribute)，就可以在開發環境中變更此唯讀屬性 (Property)。

範例

此範例會針對開啟之 Visual Basic 或 Visual C# 專案中的所有參考顯示 Description 字串。若要將此範例當做增益集來執行，請參閱 HOW TO：編譯和執行 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);
}