IBatchEvents Interface

This is a callback interface that is used for reporting events from the Project and Batch objects to the listeners. This interface is implemented on the client side. See the detailed implementation advice for your development tool in Working with Connectable Objects. Below you can find a short summary.

In C++ you need to implement the IBatchEvents interface, obtain a connection point, and "advise" object implementing the interface to the Project or Batch object. As the interface is derived from the IUnknown interface, the client object should also implement the IUnknown methods.

Visual Basic users that want to receive notifications from one of these objects should declare the event source object of the BatchEventSource type WithEvents, initialize it with the Project or Batch object and implement the Sub similar to the following:

Private Sub eventsSource_OnBatchProgress(ByVal Batch As FCEngine.IBatch, _
                                         ByVal ProcessedItemsCount As Integer, _
                                         ByVal RemainingItemsCount As Integer)
End Sub

An object receiving notifications through this interface methods may do the following inside the methods implementation:

  • Process any Windows messages, which is useful in applications having User Interface, to avoid an effect that the application "is not responding" during long recognition operations.
  • Report percentage of Document Definitions matching, recognition, and export.
  • Report recognizer tips, errors and warnings to the user.
  • Report information about processing operation completed.


Name Description
OnBatchProgress Delivers to the client information about approximate percentage of the current operation (Document Definition matching, recognition, and export).
OnError Delivers to the client information about the errors which occur during page processing.
OnPageProgress Delivers to the client information about page processing completed.
OnPageRectProcessed Delivers to the client information about processed page region.
OnProcessMessages Allows the client to terminate the current operation of batch processing.
OnRecognizerTip Delivers to the client recognizer tips.
OnWarning Delivers to the client information about the warnings which occur during page processing.

See also



Working with Connectable Objects

15.08.2023 13:19:30

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.