MaskedTextBox.PromptChar Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: MaskedTextBox.cs

Source:: MaskedTextBox.cs

Source:: MaskedTextBox.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 the character used to represent the absence of user input in MaskedTextBox.

public:
 property char PromptChar { char get(); void set(char value); };

public char PromptChar { get; set; }

member this.PromptChar : char with get, set

Public Property PromptChar As Char

Property Value

Char

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

Exceptions

ArgumentException

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

InvalidOperationException

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

Remarks

PromptChar will be displayed in MaskedTextBox for any mask position that the user has not yet filled in.

Use the HidePromptOnLeave property to specify whether the prompt is displayed when MaskedTextBox does not have focus.

Applies to

Product	Versions
.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
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via