ScanBeforeManualIdentification(FormDefList As String) As Long

Description

In this event you can show your own dialog, from which the user selects a form definition for the current Unidentified form.

If the user knows which form definition the form belongs to, return that name (one of the form definitions received in FormDefList) SetReturnValue(0, "Name of chosen Form Definition"). In this case, the form is manually identified to the specified form definition. If the name specified in the SetReturnValue is not part of the FormDefList, then FORMS’ standard dialog for manual identification appears.

If the user does not recognize the form, return an empty string SetReturnValue(0, "") to keep the form Unidentified.

After this event, the user must select what to do next in the Operator control dialog. Normally, the user clicks Continue.

This event is fired after ScanNotifyUser but before ScanUserNotified.

Note that the Job object is available even though this event is fired on application level in Scan.

Parameters

Parameter

Description

FormDefList

A semicolon-separated string. The string lists the names of all form definitions that could be valid for the current unidentified form—a subset of the form definitions specified in the job description.

Return values

Return value

Description

EV_OK

Normal return. FORMS continues with normal manual identification and shows the standard dialog.

EV_OK_ABORT 

Do not show the normal dialog. Must be used with the SetReturnValue method.

EV_ERROR

Treated the same way as EV_OK.

Suggested usage

Use this event to replace FORMS’ standard dialog or automatically select which form definition the unidentified form belongs to.

Remarks

This event is only fired:

Note that form definition names are case sensitive.

Warning

Since FORMS could not identify the document, it will not be interpreted. This is true even if a form is manually linked to a form definition in this event.

Events in Scan