DisplayAttribute.GetDescription Method

Reference

Definition

Namespace:: System.ComponentModel.DataAnnotations

Assemblies:: System.ComponentModel.Annotations.dll, System.ComponentModel.DataAnnotations.dll

Assembly:: System.ComponentModel.Annotations.dll

Assembly:: System.ComponentModel.DataAnnotations.dll

Package:: System.ComponentModel.Annotations v5.0.0

Source:: DisplayAttribute.cs

Source:: DisplayAttribute.cs

Source:: DisplayAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the value of the Description property.

public:
 System::String ^ GetDescription();

public 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.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided), 2.1 (package-provided)
UWP	10.0

Share via