This documentation is archived and is not being maintained.

DisplayAttribute.Description Property

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)

public string Description { get; set; }

Property Value

Type: System.String
The value that is used to display a description in the UI.

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.

The following example shows how to set the Description property.

public partial class Employee {
    public class EmployeeMD {
        [Display(Name = "Last Name", Order = -9, 
        Prompt = "Enter Last Name", Description="Emp Last Name")]
        public object LastName { get; set; }

        [Display(Name = "Manager", AutoGenerateFilter=false)]
        public object Employee1 { get; set; }

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.