MaskedTextResultHint MaskedTextResultHint MaskedTextResultHint MaskedTextResultHint Enum

Definition

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

public enum class MaskedTextResultHint
public enum MaskedTextResultHint
type MaskedTextResultHint = 
Public Enum MaskedTextResultHint
Inheritance
MaskedTextResultHintMaskedTextResultHintMaskedTextResultHintMaskedTextResultHint

Fields

AlphanumericCharacterExpected AlphanumericCharacterExpected AlphanumericCharacterExpected AlphanumericCharacterExpected -2

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

AsciiCharacterExpected AsciiCharacterExpected AsciiCharacterExpected AsciiCharacterExpected -1

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

CharacterEscaped CharacterEscaped CharacterEscaped CharacterEscaped 1

Success. The operation succeeded because a literal, prompt or space character was an escaped character. For more information about escaped characters, see the VerifyEscapeChar(Char, Int32) method.

DigitExpected DigitExpected DigitExpected DigitExpected -3

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

InvalidInput InvalidInput InvalidInput InvalidInput -51

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(Char) method.

LetterExpected LetterExpected LetterExpected LetterExpected -4

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

NoEffect NoEffect NoEffect NoEffect 2

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

NonEditPosition NonEditPosition NonEditPosition NonEditPosition -54

Operation did not succeed. The current position in the formatted string is a literal character.

PositionOutOfRange PositionOutOfRange PositionOutOfRange PositionOutOfRange -55

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 PromptCharNotAllowed PromptCharNotAllowed PromptCharNotAllowed -52

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

SideEffect SideEffect SideEffect SideEffect 3

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 SignedDigitExpected SignedDigitExpected SignedDigitExpected -5

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

Success Success Success Success 4

Success. The primary operation succeeded.

UnavailableEditPosition UnavailableEditPosition UnavailableEditPosition UnavailableEditPosition -53

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

Unknown Unknown Unknown Unknown 0

Unknown. The result of the operation could not be determined.

Remarks

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

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

Applies to

See Also