MaskedTextResultHint Enumeration
TOC
Collapse the table of content
Expand the table of content

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
AlphanumericCharacterExpected

Operation did not succeed.An input character was encountered that was not alphanumeric. .

AsciiCharacterExpected

Operation did not succeed.An input character was encountered that was not a member of the ASCII character set.

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.

DigitExpected

Operation did not succeed. An input character was encountered that was not a 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.

LetterExpected

Operation did not succeed. An input character was encountered that was not a letter.

NoEffect

Success. The primary operation was not performed because it was not needed; therefore, no side effect was produced.

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.

PromptCharNotAllowed

Operation did not succeed. The prompt character is not valid at input, perhaps because the AllowPromptAsInput property is set to false.

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.

SignedDigitExpected

Operation did not succeed. An input character was encountered that was not a signed digit.

Success

Success. The primary operation succeeded.

UnavailableEditPosition

Operation did not succeed. There were not enough edit positions available to fulfill the request.

Unknown

Unknown. 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.

System_CAPS_noteNote

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

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft