MaskedTextProvider.VerifyEscapeChar(Char, Int32) Method

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

MaskedTextProvider.cs

Tests whether the specified character would be escaped at the specified position.

public:
 bool VerifyEscapeChar(char input, int position);

public bool VerifyEscapeChar (char input, int position);

member this.VerifyEscapeChar : char * int -> bool

Public Function VerifyEscapeChar (input As Char, position As Integer) As Boolean

Parameters

input

Char

The Char value to test.

position

Int32

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

Returns

Boolean

true if the specified character would be escaped at the specified position; otherwise, false.

Remarks

A character is said to be escaped if it is valid input, but is not assigned to that position in the formatted string. Escaped characters fall into the following three categories:

• Prompt characters are escaped if the AllowPromptAsInput property is true.

• Input characters are escaped if they have the same value as the literal in the mask, and if the SkipLiterals property is true.

• Space characters are escaped if the ResetOnSpace property is true.

The VerifyEscapeChar method will also return false if the pos parameter is less than zero or greater than the Length of the Mask.

See also

• IsValidInputChar(Char)
• VerifyChar(Char, Int32, MaskedTextResultHint)
• VerifyString
• AllowPromptAsInput
• SkipLiterals
• ResetOnSpace