IImageViewerEvents Interface

This is a callback interface that is used for reporting events from the ImageViewer 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 blocks selection, image editing, analysis and recognition 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 Image Viewer. Delivers to the client a reference to the new page.
OnActivePageChanging Called before changing the active page in Image Viewer. Delivers to the client a reference to the new active page. Allows you to cancel the operation.
OnAfterDblClick Called after a position in a recognized block has been double-clicked in Image Viewer. Delivers to the client the index of the double-clicked block and the coordinates of the point in it.
OnAnalyzePage Called before the start of the page analysis process which has been invoked from Image Viewer. Allows you to cancel the operation.
OnAnalyzeRegion Called before the start of the block analysis process which has been invoked from Image Viewer. Delivers to the client the coordinates of the region which is going to be analyzed. Allows you to cancel the operation.
OnAnalyzeTable Called before the start of the table analysis process which has been invoked from Image Viewer. Delivers to the client the index of the block which is going to be analyzed. Allows you to cancel the operation.
OnBlockAdded Called after a new block was added in Image Viewer.
OnBlockSelectionChanged Called after blocks selection has been changed either in Image Viewer, or in Zoom Viewer synchronized with Image Viewer. Delivers to the client the index of the newly selected block.
OnChangeBlockType Called after the block type has been changed in Image Viewer or in Zoom Viewer synchronized with Image Viewer. Allows you to cancel the type change.
OnCorrectPerspective Called before correcting perspective distortions on image pages. Delivers to the client the index of the page which is going to be changed, and the coordinates of the new page corners. Allows you to cancel the operation.
OnCorrectResolution Called before changing resolution of images. Delivers to the client the indices of the pages which resolution is going to be corrected, and the value of the new resolution. Allows you to cancel the operation.
OnCropImages Called before cropping images. Delivers to the client the indices of the pages which are going to be cropped, and the coordinates of the cropping rectangle. Allows you to cancel the operation.
OnDeleteBlocks Called before deleting the blocks in Image Viewer. Delivers to the client the indices of the blocks which are going to be deleted. Allows you to cancel the operation.
OnEditImages Called before the start of image editing. Delivers to the client information on the indices of the pages which are going to be edited, and the command which will be used for editing. Allows you to cancel the operation.
OnLocked Called after Image Viewer has been locked or unlocked. Delivers to the client information on whether the Image Viewer component is locked or unlocked.
OnLongOperationFinished Called after the end of a long-term processing operation (e.g., layout analysis, recognition) in Image Viewer.
OnLongOperationStarted Called before the beginning of a long-term processing operation (e.g., layout analysis, recognition) in Image Viewer.
OnOptionsChanged Called after an option have been changed in Image Viewer. Options are specified in the Options dialog box, which is displayed if the MI_Options command is called.
OnPagesSelectionChanged Called after page selection has been changed in the Image Editor dialog box of Image Viewer.
OnProgress Called during page processing. Delivers to the client approximate percentage of the current analysis or recognition operation. Allows you to cancel the operation.
OnReadBlocks Called before the start of the blocks recognition process which has been invoked from Image Viewer. Delivers to the client the indices of blocks which are going to be recognized. Allows you to cancel the operation.
OnReadPage Called before the start of the page recognition process which has been invoked from Image Viewer. Allows you to cancel the operation.
OnScale Called before scaling an image in Image Viewer. Delivers to the client the scale value. Allows you to cancel the operation.
OnSelectTool Called after a tool has been selected either in Image Viewer, or in Zoom Viewer synchronized with Image Viewer. Delivers to the client information on the tool which has been selected.
OnSplitImages Called before splitting images. Delivers to the client information on the specific images which are going to be split, and the regions which will be used for splitting. Allows you to cancel the operation.
OnTableCellsSelected Called after table cells have been selected either in Image Viewer, or in Zoom Viewer synchronized with Image Viewer. Delivers to the client information on the index of the table block the cells of which have been selected, and the surrounding rectangle of the selected cells.
OnToolAddBlock Called before adding a new block that has been drawn with the help of a tool of Image Viewer. Delivers to the client information about the block that has been drawn: its type and region. Allows you to cancel the operation.
OnToolChangeBlockRegion Called before changing a region of the block that has been modified with the help of a tool of Image Viewer. Delivers to the client information on the blocks the regions of which are going to be changed, and the new region of the resulting block. Allows you to cancel the operation.
OnToolChangeTable Called before changing a table block that has been modified with the help of a tool of Image Viewer. Delivers to the client the index of the table block which is going to be changed, and the position and type of the new or deleted separator. Allows you to cancel the operation.
OnToolEraseRect Called before erasing a part of an image, if this process has been invoked with the help of a tool of Image Viewer. Delivers to the client information on the page which is going to be edited, and the coordinates of the erasing rectangle. Allows you to cancel the operation.
OnVisibleDocumentAreaChange Called after the visible document area has been changed in Image Viewer. Delivers to the client the coordinates of the new visible area.

Samples

This interface is used in the following code samples: VisualComponents.

See also

Working with Connectable Objects

ImageViewer

24.03.2023 8:51:52

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.