RegExFind_InBlock

RegExFind_InBlock will look for the first occurrence of a word or phrase that matches the regular expression. This action uses the document block layout that is created by the DocumentAnalytics actions.

Important: This action is currently released as a preview. If you use this action in your application, you might need to make updates to your application if a new version of this action released.

Syntax

bool RegExFind_InBlock (StrParam)

Parameters

A word or phrase to find on the current page. The parameter is expected to be a Regular Expression. The search is case sensitive.

Returns

True if the word or phrase is located within the currently selected block. Otherwise, False.

Level

Page or field level.

Details

The action locates the first occurrence of a word or phrase on the current page where the input search term is specified as a regular expression, respecting the currently selected block of the document layout. The search is started from the first word within the currently selected block.

When the document layout is created, the entire page is set as the currently selected block, making the initial search area the entire page. Once the regular expression has been matched, the location of the found word or phrase will be remembered so the result can be used by subsequent actions.

Additionally, the found word will become the currently selected word and the block region of that word becomes the currently selected block area within the document block layout. Subsequent block actions will act upon the currently selected block, allowing the area of interest to be changed to control the area of the page that is the target of subsequent actions.

Example

RegExFind_InBlock("Da.e")
SelectParentBlock() 
GoRightWord("1") 
IsDateValue()
UpdateField()

RegExFind_InBlock will look for the first occurrence of a word or phrase that matches the regular expression. If a match is found, the next action will change the currently selected block from the found word to the entire line that contains the word, then move to the right of the word. If it is a date format, UpdateField will place the value into the current field.