Propriedade Reference3.Description

Artigo
08/01/2011

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

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

Sintaxe

'Declaração
ReadOnly Property Description As String
    Get

string Description { get; }

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

abstract Description : string

function get Description () : String

Valor de propriedade

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

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

Implementações

Reference2.Description

Comentários

O Description propriedade e Name diferem de propriedade de uma referência de finalidade e o comprimento. O Name propriedade, por exemplo, System.Windows.Forms, deve ser descritivo ainda curto. O Description propriedade pode ser mais longo e contêm informações mais detalhadas. Ele tem uma descrição de biblioteca de tipo COM a mesma função.

O Description propriedade é armazenada como um atributo personalizado no assembly. Ao contrário da maioria das outras propriedades expostas pelo Reference o objeto, que são armazenadas em metadados.

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

Exemplos

Este exemplo exibe o Description seqüências de caracteres para todas as referências de uma abertura Visual Basic ou Visual C# project. Para executar este exemplo como um suplemento, consulte Como: compilar e Executar a automação de exemplos de Código do modelo de objeto.

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áveis.

Consulte também

Referência

Reference3 Interface

Sobrecargas Description

Namespace VSLangProj80

Partilhar via