DisplayAttribute.GetPrompt Method

Definition

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Source:

DisplayAttribute.cs

Returns the value of the Prompt property.

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