DisplayAttribute.GetPrompt 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 Prompt property.

public:
 System::String ^ GetPrompt();

public string GetPrompt();

public string? GetPrompt();

member this.GetPrompt : unit -> string

Public Function GetPrompt () As String

Returns

String

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

Exceptions

InvalidOperationException

Both the ResourceType property and Prompt properties were set, but a public static property with a name matching the Prompt value couldn't be found on the ResourceType.

Remarks

The Prompt property is typically used as a prompt or watermark for a UI element that is bound to the property that is annotated with the Prompt 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