ClearAltText

Clears character and confidence values from the Character Array position specified by the parameter.

Syntax

bool ClearAltText (strParam)

Parameters

The index in the Character Array where you want to clear the character and confidence values. 0 is the first index, followed by 1, etc. Smart parameters are supported.

Returns

Always True.

Level

Field level.

Details

Clears character and confidence values from the Character Array position specified by the parameter. When cleared, the confidence values are set to 10 (high confidence). (A field in the Data file can hold more than one representation of the field's value. Values other than the current, visible value are accessed via an index number. The current value is at index 0, the next value is at index 1. Each additional value also has corresponding character confidences.)
Note: Most actions only work with characters and confidence values located in the first position of the Character Array (position 0). The Cleartext action is used with User Application Web's Advanced Index task, for "Double Blind" data entry.
Example:
PropagateToAltText(1)
ClearAltText(0)

In this example, all characters at the first index (0) of the Character Array will be copied to the second index (1). The second action will then clear character and confidence values from the first index in the Character Array.