Export (0) Print
Expand All
Expand Minimize

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 nameDescription
AlphanumericCharacterExpectedOperation did not succeed.An input character was encountered that was not alphanumeric. .
AsciiCharacterExpectedOperation did not succeed.An input character was encountered that was not a member of the ASCII character set.
CharacterEscapedSuccess. The operation succeeded because a literal, prompt or space character was an escaped character. For more information about escaped characters, see the VerifyEscapeChar method.
DigitExpectedOperation did not succeed. An input character was encountered that was not a digit.
InvalidInputOperation 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.
LetterExpectedOperation did not succeed. An input character was encountered that was not a letter.
NoEffectSuccess. The primary operation was not performed because it was not needed; therefore, no side effect was produced.
NonEditPositionOperation did not succeed. The current position in the formatted string is a literal character.
PositionOutOfRangeOperation 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.
PromptCharNotAllowedOperation did not succeed. The prompt character is not valid at input, perhaps because the AllowPromptAsInput property is set to false.
SideEffectSuccess. 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.
SignedDigitExpectedOperation did not succeed. An input character was encountered that was not a signed digit.
SuccessSuccess. The primary operation succeeded.
UnavailableEditPositionOperation did not succeed. There were not enough edit positions available to fulfill the request.
UnknownUnknown. The result of the operation could not be determined.

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.

NoteNote

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 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.

Show:
© 2014 Microsoft