DisplayAttribute.GetDescription Method

Definition

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Source:

DisplayAttribute.cs

Returns the value of the Description property.

public:
 System::String ^ GetDescription();

public string? GetDescription ();

member this.GetDescription : unit -> string

Public Function GetDescription () As String

Returns

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.

Exceptions

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.

Remarks

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