Reference3.Description プロパティ

2011-08-09

参照の説明文を取得します。

名前空間: VSLangProj80
アセンブリ: VSLangProj80 (VSLangProj80.dll 内)

構文

'宣言
ReadOnly Property Description As String
    Get

string Description { get; }

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

abstract Description : string

function get Description () : String

プロパティ値

型: System.String
Reference オブジェクトの場合、戻り値は参照型によって異なります。

参照型	返される値
アセンブリ	アセンブリの説明。
COM	タイプライブラリの説明。

実装

Reference2.Description

解説

参照の 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);
}