MaskedTextProvider.VerifyChar Method (Char, Int32, MaskedTextResultHint)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Tests whether the specified character could be set successfully at the specified position.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

public bool VerifyChar(
	char input,
	int position,
	out MaskedTextResultHint hint


Type: System.Char

The Char value to test.

Type: System.Int32

The position in the mask to test the input character against.

Type: System.ComponentModel.MaskedTextResultHint

A MaskedTextResultHint that succinctly describes the result of the operation. An output parameter.

Return Value

Type: System.Boolean

true if the specified character is valid for the specified position; otherwise, false.

The VerifyChar method tests whether a single character value represents valid input at the specified position in the formatted string. This method will return false for the following reasons:

  • The pos parameter is less than zero or greater than the Length of the Mask.

  • The character input is not a valid input character, as determined by the IsValidInputChar method.

  • The input is not compatible with the mask element at the specified position, pos.

The last condition may depend on the current value of the AllowPromptAsInput, AsciiOnly, PasswordChar, PromptChar and SkipLiterals properties.

To test an entire input string against the mask, use one of the VerifyString methods instead.

.NET Framework
Available since 2.0
Return to top