This documentation is archived and is not being maintained.

MaskedTextBox.PromptChar Property

Gets or sets the character used to represent the absence of user input in MaskedTextBox.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public char PromptChar { get; set; }

Property Value

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

ExceptionCondition
ArgumentException

The character specified when setting this property is not a valid prompt character, as determined by the IsValidPasswordChar 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.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: