DisplayAttribute::Description Property

.NET Framework (current version)

Gets or sets a value that is used to display a description in the UI.

Namespace: System.ComponentModel.DataAnnotations
Assembly: System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)

Syntax

C++

public:
property String^ Description {
	String^ get();
	void set(String^ value);
}

Property Value

Type: System::String^

The value that is used to display a description in the UI.

Remarks

Do not use this property to get the value of the Description property. Use the GetDescription method instead.

The Description property is typically used as a tooltip or description UI element that is bound to the member using this attribute. The Dynamic Data Edit.ascx template will display the description as a tooltip in text-entry fields. A null value or empty string is valid.

Examples

The following example shows how to set the Description property.

C++

No code example is currently available or this language may not be supported.

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 3.0