JobFormIdentify(FrontpageImage As String, BackpageImage As String) As Long

Description

This event is fired just before a form is identified.

Parameters

Parameter

Description

FrontpageImage  

Complete file name, including the full path, of the image file containing the front page of the form. Can be:

  • An empty string

  • ArchiveImage for a front page, when you are scanning forms that have Export forms to image files selected in the form definition settings

  • SourceImage for a front page, when interpreting imported image files

BackpageImage  

Complete file name, including the full path, of the image file containing the back page of the form. Can be:

  • An empty string

  • ArchiveImage for a back page, when you are scanning forms that have Export forms to image files

  • SourceImage for a back page, when you are when interpreting imported image files

Return values

Return value

Description

EV_OK

Normal return.

EV_OK_ABORT 

No effect— treated the same as EV_OK.

EV_ERROR

Causes an error message to be presented.

Suggested usage

To tell FORMS which form definition a document is, rather than letting FORMS figure it out. Helps FORMS to quickly identify a form when you already know what it is. Use with the AddExternalValidFormDef or ForceExternalValidFormDef method.

Remarks

This event is only fired in the Scan and Interpret module s.

If you use Interpret to import image files, this event does not fire for images with a size that deviates from the form definitions by more than 20%. Such images are given Unidentified status directly.

Job-level events