SelectSnippet

Populates a snippet field with the recognized value of the located word. Used with directional actions.

Syntax

bool SelectSnippet (strParam)

Parameters

The character that is to appear in the Snippet field if a value is not available. "~" is the default.
The size of the captured value's snippet image. 1" is 1x of the actual word area, and is the default. "2" is 2x of the actual word area, the zone is twice the size of the selected target word. ".5" is 1/2 the actual word area, not recommended as only a portion of the target word would display in the snippet at verify time.

Smart parameters are supported.

Returns

Always True.

Level

Field level only.

Details

Used in conjunction with directional actions, this action will populate a Snippet field with the recognized value of the located word or phrase.

This action is usually the last rule of a Locate RuleSet, and is used when the probable area of the sought after value has been found.

Example

FindKeyInList("InvNum")
GoRightWord("1")
SelectSnippet("~,1")

This sequence first tries to locate an Invoices Number keyword in the current page. If successful, the next action attempts to lock onto a word or phrase to the right of the located word or phrase.

If that word is present, the SelectSnippet action will place the image of the word's recognized value into the Snippet of the applicable Field object. The Data Entry operator can then determine if the Snippet contains the correct value and can enter the data into the accompanying Data Edit field in the Data Entry Panel.