This topic has not yet been rated - Rate this topic

MaskedTextResultHint Enumeration

Specifies values that succinctly describe the results of a masked text parsing operation.

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
public enum MaskedTextResultHint
Member name Description
Unknown Unknown. The result of the operation could not be determined.
CharacterEscaped Success. The operation succeeded because a literal, prompt or space character was an escaped character. For more information about escaped characters, see the VerifyEscapeChar method.
NoEffect Success. The primary operation was not performed because it was not needed; therefore, no side effect was produced.
SideEffect Success. The primary operation was not performed because it was not needed, but the method produced a side effect. For example, the RemoveAt method can delete an unassigned edit position, which causes left-shifting of subsequent characters in the formatted string.
Success Success. The primary operation succeeded.
AsciiCharacterExpected Operation did not succeed.An input character was encountered that was not a member of the ASCII character set.
AlphanumericCharacterExpected Operation did not succeed.An input character was encountered that was not alphanumeric. .
DigitExpected Operation did not succeed. An input character was encountered that was not a digit.
LetterExpected Operation did not succeed. An input character was encountered that was not a letter.
SignedDigitExpected Operation did not succeed. An input character was encountered that was not a signed digit.
InvalidInput Operation did not succeed. The program encountered an input character that was not valid. For more information about characters that are not valid, see the IsValidInputChar method.
PromptCharNotAllowed Operation did not succeed. The prompt character is not valid at input, perhaps because the AllowPromptAsInput property is set to false.
UnavailableEditPosition Operation did not succeed. There were not enough edit positions available to fulfill the request.
NonEditPosition Operation did not succeed. The current position in the formatted string is a literal character.
PositionOutOfRange Operation did not succeed. The specified position is not in the range of the target string; typically it is either less than zero or greater then the length of the target string.

The MaskedTextBox control delegates the actual responsibility for parsing the input characters to the MaskedTextProvider class. Many of the methods of MaskedTextProvider, in addition to returning a Boolean success result, also provide an additional output parameter of type MaskedTextResultHint. This enumeration provides additional information about the operation of the method.

Note Note

The GetOperationResultFromHint method can be used to convert a MaskedTextResultHint value into a Boolean success value.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ