ReadZonesFPX

Member of namespace

FPXML

Syntax

bool ReadZonesFPX ()

Parameters

None.

Returns

False, if the fingerprint.xml cannot be loaded or if SetDirectoryFPX has not been called to set the location of the fingerprint XML files. Otherwise, True.

Level

Page or Field level.

Details

This action reads the field zone information from the fingerprint XML file associated with the fingerprint for the current page object. This action is similar to the ReadZones action in the Zones library. The primary difference is that ReadZones reads the zone information stored in the setup DCO and ReadZonesFPX reads the zone information from the associated fingerprint XML file. Typically this action is called after the CreateFields action but before field recognition. ReadZonesFPX loads position information for each node in the calling object and it's children. Pre-adjusts these values based on offset information stored in the Image_Offset variable at any node level.

The offset value is applied to all child objects of a node where an Image_Offset variable is found; unless overwritten by a child node also having an Image_Offset value to apply.

Position information is based on the Fingerprint XML position for the parent page's fingerprint ID.

If Enable FPXML setting is checked in the application settings Main tab in the Datacap Application Manager, Datacap Studio places field zone information into a fingerprint XML file instead of placing the zone information into the applications setup DCO. One FPXML file is created per fingerprint. Depending on application needs, using fingerprint XML files might have advantages. Refer to Datacap documentation for more information about using fingerprint XML files.

If the application is using FPXML files, then use this action to load the zones.

Example:

SetDirectoryFPX("@APPPATH(*/fingerprint)")
ReadZonesFPX()