Reference.Description Property

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

Namespace:  VSLangProj
Assembly:  VSLangProj (in VSLangProj.dll)

Syntax

'Declaration
ReadOnly Property Description As String
string Description { get; }
property String^ Description {
    String^ get ();
}
abstract Description : string with get
function get Description () : String

Property Value

Type: String
For a Reference object, the return value depends on the reference type.

Reference Type

Value Returned

Assembly

Assembly description.

COM

Type library description.

Remarks

The Description property and Name 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).

Examples

See the example in Reference.

.NET Framework Security

See Also

Reference

Reference Interface

VSLangProj Namespace