This documentation is archived and is not being maintained.

MaskedTextProvider.VerifyEscapeChar Method

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

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

public bool VerifyEscapeChar(
	char input,
	int position


Type: System.Char
The Char value to test.
Type: System.Int32
The position in the mask to test the input character against.

Return Value

Type: System.Boolean
true if the specified character would be escaped at the specified position; otherwise, false.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.