Reference2.Description Property

Definition

Namespace:

VSLangProj2

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets a text description of the reference. Read-only.

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

Property Value

String

For a Reference object, the return value depends on the reference type.Reference TypeValue ReturnedAssemblyAssembly description.COMType library description.

Implements

Description

Attributes

DispIdAttribute

Remarks

The Description property and Name property of a reference differ in purpose and length. The Name property, for example System.Windows.Forms, is meant to be descriptive yet short. The Description property may be longer and contain more detailed information. It has the same function as a COM type library description.

The Description property is stored as a custom attribute in the assembly. This is unlike most other properties exposed by the Reference object, which are stored in the metadata.

This read-only property may be changed in the development environment by editing the custom attributes in the AssemblyInfo.vb file (for Visual Basic projects) or the AssemblyInfo.cs file (C# projects).