System.ComponentModel.MaskedTextResultHint Enumeration

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

Syntax

public enum MaskedTextResultHint

Remarks

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

Note:

The MaskedTextProvider.GetOperationResultFromHint(MaskedTextResultHint) method can be used to convert a System.ComponentModel.MaskedTextResultHint value into a bool success value.

Members

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 MaskedTextProvider.VerifyEscapeChar(char, int) 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 MaskedTextProvider.IsValidInputChar(char) 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 MaskedTextProvider.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 erload:System.ComponentModel.MaskedTextProvider.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.

Requirements

Namespace: System.ComponentModel
Assembly: System (in System.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0