Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

MaskedTextBox.ResetOnPrompt Property

Gets or sets a value that determines how an input character that matches the prompt character should be handled.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public bool ResetOnPrompt { get; set; }
/** @property */
public boolean get_ResetOnPrompt ()

/** @property */
public void set_ResetOnPrompt (boolean value)

public function get ResetOnPrompt () : boolean

public function set ResetOnPrompt (value : boolean)

Not applicable.

Property Value

true if the prompt character entered as input causes the current editable position in the mask to be reset; otherwise, false to indicate that the prompt character is to be processed as a normal input character. The default is true.

The MaskedTextBox can treat two categories of characters—spaces and prompt characters—specially. Typically, each input character will be tested against the mask and either accepted or rejected. Assuming that the PromptChar property is set to non-a null reference (Nothing in Visual Basic), then setting the ResetOnPrompt property to true will result in special processing for the prompt character. When the user enters the prompt character into the mask, it causes the current mask character position to be cleared and the current position to be advanced to the next editable character.

ResetOnPrompt takes precedence over the AllowPromptAsInput property, as shown in the following table.

ResetOnPrompt value

AllowPromptAsInput value

Resulting behavior

true

true

The prompt character can be entered and it causes the current mask position to be reset. This is the default.

true

false

The prompt character can be entered and it causes the current mask position to be reset.

false

true

The prompt character is processed as a standard input character.

false

false

The prompt character is not valid and raises a MaskInputRejected event.

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.