Reference3.Description (Propiedad)

Obtiene una descripción de texto de la referencia.

Espacio de nombres:  VSLangProj80
Ensamblado:  VSLangProj80 (en VSLangProj80.dll)

Sintaxis

'Declaración
ReadOnly Property Description As String
    Get

string Description { get; }

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

abstract Description : string

function get Description () : String

Valor de propiedad

Tipo: System.String
Para un objeto Reference, el valor devuelto depende del tipo de referencia.

Tipo de referencia	Valor devuelto
Ensamblado	Descripción del ensamblado.
COM	Descripción de la biblioteca de tipos.

Implementaciones

Reference2.Description

Comentarios

Las propiedades Description y Name de una referencia difieren en propósito y longitud. La propiedad Name, por ejemplo System.Windows.Forms, debe ser descriptiva pero breve. La propiedad Description puede ser más larga y contener información más detallada. Tiene la misma función que la descripción de una biblioteca de tipos de COM.

La propiedad Description se almacena como un atributo personalizado en el ensamblado. No sucede lo mismo con la mayoría de las demás propiedades expuestas por el objeto Reference, que se almacenan en los metadatos.

Esta propiedad de solo lectura se puede cambiar en el entorno de desarrollo editando los atributos personalizados en el archivo AssemblyInfo.vb (para los proyectos de Visual Basic) o en el archivo AssemblyInfo.cs (para los proyectos de Visual C#).

Ejemplos

En este ejemplo se muestran las cadenas de Description para todas las referencias en un proyecto de Visual Basic o Visual C# abierto. Para ejecutar este ejemplo como complemento, vea Cómo: Compilar y ejecutar los ejemplos de código del modelo de objetos de automatización.

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

Seguridad de .NET Framework

• Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.

Vea también

Referencia

Reference3 Interfaz

Description (Sobrecarga)

VSLangProj80 (Espacio de nombres)