FindKeyList

Locates the first or next occurrence of a word or phrase that matches one of the entries in a keyword file.

Syntax

bool FindKeyList (StrParam)

Parameters

The name of the Keyword text file. The file will contain a list of words or phrases, separated by new lines, that will be used for matching.
The file name can be provided in one of two ways:
  1. A full path name of the file, including the .key extension.
  2. The file name only, with no extension specified. The application will look in the process directory and the file must have a .key extension.
Smart parameters are supported.

Returns

True if at least one word on the page matches any word or pattern in the Keyword file. Otherwise, False.

Level

Field level only.

Details

Opens the Keyword file you specify as a parameter, then checks the words or phrases on the current page against the keywords in the list to find a match. The location of the found word or phrase that matches an entry in the keyword file will be remembered so the result can be used by subsequent actions. Matching is case sensitive.

To improve matching, this action automatically adjusts the search criteria to allow for common character substitutions. For example, if the list includes "will" and the recognition read "wi11", a match will still occur.

Common substitutions include characters: B8, Z2, S5, oO0 and iItl1.

Example
FindKeyList("InvNum")  

This action searches the current page, from first word to the last word of the current page, for the first keyword in the Invoices Number Keyword file (InvNum.key). If successful, the search stops and remembers the location of that word for subsequent actions; if not, the action continues searching for the next word in InvNum.key, starting from first word of the current page, repeating this search pattern until a match is found, or until there are no more keywords.