English (English)
IDocumentViewerEvents Interface
This is a callback interface that is used for reporting events from the DocumentViewer 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.
This interface is derived from IInputEvents interface and inherits all its methods.
An object receiving notifications through this interface's methods may do the following inside the methods' implementation:
- Report information on image editing, document analysis, recognition and export, and cancel these operations.
- Process any Windows messages, which is useful in applications having user interface, to avoid the effect that the application "is not responding" during long operations.
- Report information about mouse moving and clicking, key pressing, scrolling.
Methods
| Name | Description |
|---|---|
| OnActivePageChanged | Called after the active page has been changed in Document Viewer. Delivers to the client a reference to the new page. |
| OnActivePageChanging | Called before changing the active page in Document Viewer. Delivers to the client a reference to the new active page. Allows you to cancel the operation. |
| OnAnalyzePages | Called before the start of the page analysis process which has been invoked from Document Viewer. Allows you to cancel the operation. |
| OnDeletePages | Called before deleting a page from the document in Document Viewer. Allows you to cancel the operation. |
| OnDocumentChanged | Called after the active document has been changed in Document Viewer. Delivers to the client a reference to the new document. |
| OnEditImages | Called before the start of image editing. Delivers to the client information on the command which will be used for editing. Allows you to cancel the operation. |
| OnExportPages | Called before the start of the export process which has been invoked from Document Viewer. Delivers to the client information on the export operation: export file name and format, parameters of export, and the indices of pages that are going to be exported. Allows you to cancel the operation. |
| OnLocked | Called after Document Viewer has been locked or unlocked. Delivers to the client information on whether the Document Viewer component is locked or unlocked. |
| OnLongOperationFinished | Called after the end of a long-term processing operation (e.g., layout analysis, recognition) in Document Viewer. |
| OnLongOperationStarted | Called before the beginning of a long-term processing operation (e.g., layout analysis, recognition) in Document Viewer. |
| OnOptionsChanged | Called after an option have been changed in Document Viewer. Options are specified in the Options dialog box, which is displayed if the MI_Options command is called, or if the Options button is clicked in the Save As dialog box of Document Viewer. |
| OnPagesSelectionChanged | Called after page selection has been changed in Document Viewer. |
| OnProgress | Called during document processing. Delivers to the client approximate percentage of the current analysis or recognition operation. Allows you to cancel the operation. |
| OnReadPages | Called before the start of the page recognition process which has been invoked from Document Viewer. Allows you to cancel the operation. |
| OnRenumberingPages | Called before renumbering pages in Document Viewer. Delivers to the client the new order of pages. Allows you to cancel the operation. |
| OnRenumberPages | Called before opening the Renumber Pages dialog box in Document Viewer. Allows you to cancel the operation. |
| OnSendToPages | Called before sending recognized pages from Document Viewer to an external application. Delivers to the client information on the application, to which the pages are going to be sent, and the parameters of export. Allows you to cancel the operation. |
Samples
This interface is used in the following code samples: VisualComponents.
See also
17.09.2024 15:14:40