MaskedTextProvider.ResetOnPrompt Property

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

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)

public bool ResetOnPrompt { get; set; }

Property Value

Type: System.Boolean
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.

MaskedTextProvider can treat two categories of characters, paces and prompt characters, in a special manner. Normally, each input character will be tested against the mask and either accepted or rejected. Operating on the assumption that the PromptChar property is set to a value other than null, then setting the ResetOnPrompt property to true will result in special processing for the prompt character. When a prompt character is added, 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 described in the following table.

ResetOnPrompt

AllowPromptAsInput

Resulting behavior

true

true

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

true

false

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

false

true

The prompt character is processed as a normal input character.

false

false

The prompt character is not valid and methods attempting to add the character will fail.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft