IFRPagesEvents Interface

IFRPagesEvents interface in the ABBYY FineReader Engine API — Client-side callback interface for reporting events (PageAdded, PageRemoved, PagesRenumbered) from an FRPages collection to listeners.

This is a callback interface that is used for reporting events from the FRPages object 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. A brief description is below:

C++ users will need to implement the IFRPagesEvents interface, obtain a connection point (Windows), and “advise” object implementing the interface to the FRPages 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 the FRPages object should declare it WithEvents and implement the procedures similar to the following:

Public WithEvents pages As FREngine.FRPages
Private Sub pages_PageRemoved(ByVal sender As FRPages, _
                              ByVal page As FRPage, _
                              ByVal index  As Integer)
...
End Sub

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

• Report information about page removing and adding completed.
• Report information about pages renumbering completed.
• In Windows: Process any system messages to help prevent the application from appearing unresponsive during long operations. This can be helpful in applications with a user interface.

Methods

Name	Description
PageAdded	Delivers to the client information about page adding completed.
PageRemoved	Delivers to the client information about page removing completed.
PagesRenumbered	Delivers to the client information about pages renumbering completed.

Remarks

In Linux, this interface does not work if the Engine object is loaded as an out-of-process server.

See also

FRPages

Working with Connectable Objects