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 Property Description As String

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.

<MetadataType(GetType(EmployeeMD))>  _
Public Class Employee

    Public Class EmployeeMD

        <Display(Name:="Last Name", Order:=-9, _
           Prompt:="Enter Last Name", Description:="Emp Last Name")>  _
        Public Property LastName As Object
        End Property

        <Display(Name:="Manager", AutoGenerateFilter:=false)>  _
        Public Property Employee1 As Object
        End Property
    End Class
End Class

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
Return to top
Show: