LEADTOOLS Forms (Leadtools.Forms.Processing assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
RegexPattern Property
See Also 
Leadtools.Forms.Processing Namespace > TextFormField Class : RegexPattern Property



The RegexPattern Property is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

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

Syntax

Visual Basic (Declaration) 
Public Property RegexPattern As String
Visual Basic (Usage)Copy Code
Dim instance As TextFormField
Dim value As String
 
instance.RegexPattern = value
 
value = instance.RegexPattern
C# 
public string RegexPattern {get; set;}
C++/CLI 
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: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Forms requires a Forms Module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features