RegexPattern Property

Gets or sets an optional regular expression which defines the string to read.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public string RegexPattern {get; set;}

'Declaration
 
Public Property RegexPattern As String

'Usage
 
Dim instance As TextFormField
Dim value As String
 
instance.RegexPattern = value
 
value = instance.RegexPattern

public string RegexPattern {get; set;}

 get_RegexPattern();
 set_RegexPattern(value);

public:
property String^ RegexPattern {
   String^ get();
   void set (    String^ value);
}

Property Value

The string containing the regular expression used to filter the text field string. A value of null (Nothing in Visual Basic) means no regular expression pattern matching will be performed on this field.

Remarks

Using regular expression does not change the results of the processing. However the value of the TextFormFieldResult.IsValidated of the TextFormFieldResult object will determine whether the text read matches the specified regular expression.

For example, if you set TextFormField.RegexPattern to a date expression such as "MM-DD-YYYY" and the value of the result text in OcrFormFieldResult.Text is "9 12 09", then the regular expression is not matched and the value of TextFormFieldResult.IsValidated will be false. If however the value of the result text is "09-12-2009", then the regular expression is matched and the value of TextFormFieldResult.IsValidated will be true.

Requirements

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

Reference

TextFormField Class
TextFormField Members