MaskedTextProvider.PromptChar Property

Definition

Gets or sets the character used to represent the absence of user input for all available edit positions.

C#
public char PromptChar { get; set; }

Property Value

The character used to prompt the user for input. The default is an underscore (_).

Exceptions

The prompt character specified when setting this property is the same as the current password character, PasswordChar. The two are required to be different.

The character specified when setting this property is not a valid password character, as determined by the IsValidPasswordChar(Char) method.

Remarks

The PromptChar property represents the prompt character that is used by the ToDisplayString and ToString methods to represent the current state of the formatted input string. A prompt character is placed in editable positions that have not yet been assigned an input value. Some versions of the ToString method also depend on the value of the IncludePrompt property.

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 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, 2.1

See also