Reference3.Description - свойство

Статья
11/19/2008

Обновлен: Ноябрь 2007

Возвращает текстовое описание ссылки.

Пространство имен: VSLangProj80
Сборка: VSLangProj80 (в VSLangProj80.dll)

Синтаксис

'Декларация
ReadOnly Property Description As String
'Применение
Dim instance As Reference3
Dim value As String

value = instance.Description

string Description { get; }

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

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#) или AssemblyInfo.jsl file (для проектов Visual J#).

Примеры

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

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, C#, or J# 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, C#, or J# 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);
}

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.