Reference3::Description Property
Gets a text description of the reference.
Assembly: VSLangProj80 (in VSLangProj80.dll)
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. |
Implements
Reference2::DescriptionThe 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 (Visual C# projects).
This example displays the Description strings for all references in an open Visual Basic or Visual C# project. To run this example as an add-in, see How to: Compile and Run the Automation Object Model Code Examples.