Reference::Description Property

Visual Studio 2015
 

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

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

C#
C++
F#
VB
Copy 
property String^ Description {
	String^ get();
}

Property Value

Type: System::String^

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

Reference Type

Value Returned

Assembly

Assembly description.

COM

Type library description.

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).

See the example in Reference.

Return to top
Show: