PIC_FilterFields

Validates the format of the current field, when called from a field, or all fields on the current page, when called from a page. Uses the picture string that is stored in the PictureString variable of the field.

Syntax

bool PIC_FilterFields ()

Parameters

None.

Returns

Always True.

Level

All levels.

Details

Replaces a character and adjusts the confidence based on the PictureString defined for the field.

Lowers the Confidence Rating of any character in a field that does not satisfy the Picture String's criteria and replaces the problem character with a low confidence space. It is very similar to the FormatFields action but does not use alternative recognition characters.

This action has two roles. If a character in the field does not match the picture string format defined for that field
  1. It replaces any "problem" characters with a space character and marked as low confidence.
  2. It lowers the Confidence Rating of any character in a field that does not satisfy the Picture String's criteria.
  3. Any alternative recognition characters are removed from the field after execution.
Note: This Action is recursive and will affect all child fields of the calling node. While not direct input to this action, this action works with picture strings that are defined for a field. See the PIC_FormatFields action for a list of all available picture string codes and information about the PictureString variable.
Example
rrSet("XxN,@F.PictureString")
PIC_FilterFields()

This example expects the current field to have the first character be either a alphabetic character or a digit, the second character can be an alphabetic character, digit or punctuation character and the remaining characters must only be digits.