This documentation is archived and is not being maintained.

DisplayAttribute.GetDescription Method

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.

ExceptionCondition
InvalidOperationException

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.

.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.
Show: