Propriedade Reference3.Description

Artigo
05/17/2015

Obtém uma descrição de texto de referência.

Namespace: VSLangProj80
Assembly: VSLangProj80 (em VSLangProj80.dll)

Sintaxe

'Declaração
ReadOnly Property Description As String

string Description { get; }

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

abstract Description : string with get

function get Description () : String

Valor de propriedade

Tipo: String
Para um objeto de Reference , o valor de retorno dependerá do tipo de referência.

Tipo de referência	Valor retornado
Assembly	Descrição do assembly.
COM	Descrição da biblioteca de tipos.

Comentários

A propriedade de Description e a propriedade de Name de uma referência diferem de propósito e comprimento. A propriedade de Name , por exemplo System.Windows.Forms, se destina a ser descritiva no entanto curto. A propriedade de Description pode ser mais longa e conter informações mais detalhadas. Tem a mesma função que uma descrição da biblioteca de tipos COM.

A propriedade de Description é armazenada como um atributo personalizado no assembly. Isso é diferente da maioria de outras propriedades expostas pelo objeto de Reference , que estão armazenadas nos metadados.

Essa propriedade somente leitura pode ser alterada no ambiente de desenvolvimento editando os atributos personalizados no arquivo de AssemblyInfo.vb (para projetos de Visual Basic ) ou no arquivo de AssemblyInfo.cs (projetos deVisual C# ).

Exemplos

Esse exemplo exibe as cadeias de caracteres de Description para todas as referências em Visual Basic ou em um projeto aberto de Visual C# . Para executar este exemplo como um suplemento, consulte Como compilar e executar os exemplos de código do modelo de objeto 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);
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.

Consulte também

Referência

Reference3 Interface

Namespace VSLangProj80

Partilhar via