DisplayAttribute.GetDescription Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the value of the Description property.

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

public string GetDescription()

Return Value

Type: System.String

The localized description, if the ResourceType has been specified and the Description property represents a resource key; otherwise, the non-localized value of the Description property.

Exception Condition

The ResourceType property and the Description property are initialized, but a public static property that has a name that matches the Description value could not be found for the ResourceType property.

The Description property is typically used as a tooltip for the property that is annotated with this attribute.

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