DisplayAttribute.Prompt Property

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.

Gets or sets a value that will be used to set the watermark for prompts in the UI.

public:
 property System::String ^ Prompt { System::String ^ get(); void set(System::String ^ value); };

public string Prompt { get; set; }

public string? Prompt { get; set; }

member this.Prompt : string with get, set

Public Property Prompt As String

Property Value

String

A value that will be used to display a watermark in the UI.

Examples

The following example shows how to set the Prompt property to "Enter Last Name".

[MetadataType(typeof(EmployeeMD))]  
public partial class Employee {  
    public class EmployeeMD {  
        [Display(Name = "Last Name", Order = -9,   
        Prompt = "Enter Last Name", Description="Emp Last Name")]  
        public object LastName { get; set; }  

        [Display(Name = "Manager", AutoGenerateFilter=false)]  
        public object Employee1 { get; set; }  
    }  
}

<MetadataType(GetType(EmployeeMD))>  _  
Public Class Employee  

    Public Class EmployeeMD  

        <Display(Name:="Last Name", Order:=-9, _  
           Prompt:="Enter Last Name", Description:="Emp Last Name")>  _  
        Public Property LastName As Object  
        End Property  

        <Display(Name:="Manager", AutoGenerateFilter:=false)>  _  
        Public Property Employee1 As Object  
        End Property  
    End Class  
End Class

Remarks

This property is typically used as a prompt or watermark for a UI element that is bound to the property that is annotated with this attribute. Do not use this method to access the prompt string. Use the GetPrompt method instead.

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