Reference3.Description Свойство

Определение

Получает текстовое описание ссылки.

public:
 property System::String ^ Description { System::String ^ get(); };
public:
 property Platform::String ^ Description { Platform::String ^ get(); };
[System.Runtime.InteropServices.DispId(9)]
public string Description { [System.Runtime.InteropServices.DispId(9)] get; }
[<System.Runtime.InteropServices.DispId(9)>]
[<get: System.Runtime.InteropServices.DispId(9)>]
member this.Description : string
Public ReadOnly Property Description As String

Значение свойства

String

Для Reference объекта возвращаемое значение зависит от ссылочного типа. Ссылка на Типевалуе Ретурнедассембляссембли Description. COMType, описание библиотеки.

Реализации

Атрибуты

Примеры

В этом примере отображаются Description строки для всех ссылок в открытом Visual Basic проекте или Visual C# . Чтобы запустить этот пример в качестве надстройки, см. статью как скомпилировать и запустить примеры кода объектной модели автоматизации.

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

Комментарии

DescriptionСвойство и Name свойство ссылки отличаются в назначении и длине. NameСвойство, например System. Windows. Forms, должно быть описательным, но коротким. DescriptionСвойство может быть длинным и содержать более подробные сведения. Она имеет ту же функцию, что и описание библиотеки типов COM.

DescriptionСвойство хранится в сборке в виде пользовательского атрибута. Это не похоже на большинство других свойств, предоставляемых Reference объектом, которые хранятся в метаданных.

Это свойство, доступное только для чтения, может быть изменено в среде разработки путем редактирования пользовательских атрибутов в файле AssemblyInfo. vb (для Visual Basic проектов) или файла AssemblyInfo.cs ( Visual C# проектов).

Применяется к