Locate actions
Use the Locate actions in combination with full text recognition to locate words or regular expressions on the page. And to move around the page by line or word.
The Locate library also includes a few format validation actions, such as IsCurrency and IsDateValue. Most of the validation actions are located in the Validate library.
- AddKeyList
Adds a list of keywords or phrases that can be used for matching. - AggregateKeyList
Toggles the Key list searches to merge all words or phrases in the list into a single query. - CreateVirtualPage
This action creates a new page that is a subset of an existing page or a subset of merged pages. - CreateVirtualZone
Creates a field zone at runtime based on the identified text locations. - DefaultValue
Sets the text value of the current field in the page data file to the value that is specified. - FilterIt
Removes all instances of the specified characters from the word that is located. - FindDBList
Locates a word that matches one of a list of words that are obtained from a SQL query. - FindDBList_InZone
Locates a word that matches a word from the current field. - FindKeyList
Locates the first or next occurrence of a word or phrase that matches one of the entries in a keyword file. - FindKeyList_InZone
Locates the first (or next) occurrence of a word or phrase that matches one of the entries in the current field. - FindLastKeyList
Locates the last occurrence of a word or phrase that matches one of the entries in a keyword file. - FindLastKeyList_InZone
Locates the last occurrence of a word or phrase that matches one of the current field. - FindLastRegEx
Same as the FindLastWord action, except that it supports regular expressions. - FindLastRegEx_InZone
Same as the FindLastWord_InZone action, except that it supports regular expressions. - FindLastRegExList
Same as the FindLastKeyList action, except that it supports regular expressions. - FindLastRegExList_InZone
Same as the FindLastRegExList action, except that it searches the current field only. - FindLastWord
Locates the last occurrence of the specified word or phrase on the current page. - FindLastWord_InZone
Locates the last occurrence of the specified word or phrase on the current field. - FindNextDBList
Same as the FindDBList action, except that it locates the next instance. - FindNextDBList_InZone
Same as the FindNextDBList action, except that it searches the current field only. - FindNextKeyList
Same as the FindKeyList action, except that it locates the next instance. - FindNextKeyList_InZone
Same as the FindNextKeyList action, except that it searches the current field only. - FindNextRegExList
Same as the FindRegExList action, except that it locates the next instance. - FindNextRegExList_InZone
Same as the FindNextRegExList action, except that it searches the current field only. - FindRegExList
Same as the FindKeyList action, except that it supports regular expressions. - FindRegExList_InZone
Same as the FindRegExList action, except that it searches the current field only. - GetSelectedBlockType
Obtains the type of the currently selected block and stores it in the DCO location indicated by the target parameter. This action uses the document block layout that is created by the DocumentAnalytics actions. - GoAboveWord
Moves up the specified number of lines from the previously found word or phrase. - GoBelowWord
Moves down the specified number of lines from the previously found word or phrase. - GoDownLine
Moves down the specified number of lines from the previously found word or phrase and selects the first word. - GoFirstLine
Moves to the first line of the page when you are running full page recognition. - GoFirstWord
Moves to the first word on the current line. - GoLastLine
Moves to the last line of the page when you are running full page recognition. - GoLastWord
Moves to the last word on the current line. - GoLeftWord
Moves the specified number of words to the left of the previously found word or phrase. - GoRightWord
Moves the specified number of words to the right of the previously found word or phrase. - GoSiblingBlockNext
The currently selected block in the document layout is changed to the next sibling block at the same level in the structure. The number of siblings that are moved is determined by the input parameter. This action uses the document block layout that is created by the DocumentAnalytics actions. - GoSiblingBlockPrevious
The currently selected block in the document layout is changed to the previous sibling block at the same level in the structure. The number of siblings moved is determined by the input parameter. This action uses the document block layout that is created by the DocumentAnalytics actions. - GoUpLine
Moves up the specified number of lines from the previously found word or phrase and selects the first word. - GroupWords
Groups words to the left and right of the previously found word if they are no more than the specified number of character widths apart. - GroupWordsLEFT
Groups words to the left of the previously found word if they are no more than the specified number of character widths apart. - GroupWordsRIGHT
Groups words to the right of the previously found word if they are no more than the specified number of character widths apart. - IsAlpha
Determines whether the specified percentage of characters in a located word is letters (defaults to 100%) - IsCurrency
Determines whether the value of the located word is a currency value. The value contains numbers and includes a two-digit decimal amount. - IsDateValue
Determines whether the value of the located word is in one of the supported date formats. - IsNumber
Determines whether the specified percentage of characters in a located word is numbers (defaults to 100%) - IsSelectedBlockType
Compares the provided block type to the type of the currently selected block. This action uses the document block layout that is created by the DocumentAnalytics actions. - IsValue
Determines whether the value of the located word matches the value that is specified. - IsValue_RegEx
Determines whether the value of the located word matches the regular expression specified. - LocatePositionRestore
LocatePositionRestore returns the internal locate word pointer to the word position it was on when LocatePositionSave was called. - LocatePositionSave
LocatePositionSave creates a restore point for the current word position of the locate pointer. - MaxLength
Determines whether the number of characters in the located word is greater than or equal to the number specified. - MergeWordLF
Merges the located word with one or more words to the left, on the same line. - MergeWordRT
Merges the located word with one or more words to the right, on the same line. - MinLength
Determines whether the number of characters in the located word is less than or equal to the number specified. - RegExFind
Same as the WordFind action, except that it supports regular expressions. - 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. - RegExFind_InZone
Same as the RegExFind action, except that it searches the current field only. - RegExFindNext
Same as the WordFindNext action, except that it supports regular expressions. - RegExFindNext_InBlock
Starting from the location of a previously found word or phrase, this action locates the first occurrence of a word or phrase in the currently selected block where the input search term is specified as a regular expression. 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. This action uses the document block layout that is created by the DocumentAnalytics actions. - RegExFindNext_InZone
Same as the RegExFindNext action, except that it searches the current field only. - ScanRT
Moves the specified number of words to the right of the current word. Expands the search area up and down slightly in case the word is a little above or below the current word. - SelectParentBlock
Looks 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. SelectParentBlock is then called again to change the selected block to the parent of the current line, then the current field zone is updated to contain the entire set of lines contained in the current block and the field value is set to all of the text within the current block. This action utilizes the document block layout created by the DocumentAnalytics actions. - SelectParentBlockOuterType
Selects the outermost parent of the current block of the type that is specified. If the currently selected block has multiple parent blocks of the same type, then the parent farthest from the current block is selected. This action uses the document block layout that is created by the DocumentAnalytics actions. - SelectParentBlockType
Selects the parent of the current block of the type that is specified. If the currently selected block has multiple parent blocks of the same type, then the parent nearest to the current block would be selected. Uses the document block layout created by the DocumentAnalytics actions. - SelectSnippet
Populates a snippet field with the recognized value of the located word. Used with directional actions. - SetKeyFileEncodingAsUnicode
Determines if the Locate key files are opened as ASCII or UNICODE. - SetRect
Sets the position and size of the current field in the page data file to the values specified. - SetVirtualPageEndPosition
Use this action after you use the Locate commands that identify the last word of a new virtual page. - SetVirtualPageStartPosition
Use this action after you use the Locate commands that identify the first word of a new virtual page. - UpdateDCOField
Updates the position coordinates for the specified field in the page data file with the position of the located word. - UpdateField
Updates the current field in the page data file with the value and position of the located word. - UpdateFieldWithBlock
Updates the current DCO object's field zone coordinates with the coordinates of the currently selected block. The text of the field will be set with the contents of the text bound by the currently selected block in the document layout. Uses the document block layout created by the DocumentAnalytics actions. - ValueInField
Determines whether any part of the located word matches the value that is specified. - ValueInField_Fuzzy
Uses fuzzy matching to determine whether any part of the located word matches the value that is specified. - ValueInField_RegEx
Determines whether any character or series of characters in the located word matches the specified regular expression. - WordFind
Locates the first or next occurrence of the specified word or phrase on the current page. - WordFind_InZone
Same as the WordFind action, except that it searches the current field only. - WordFindNext
Same as the WordFind action, except that it locates the next occurrence. - WordFindNext_InZone
Same as the WordFindNext action, except that it searches the current field only. - WordFind_Offset
Sets the value of the page's Image_Offfset variable. The variable is based on the difference in the position of the specified word on the current page and on the matched fingerprint image.
Parent topic: Global actions