OnSplitImages Method of the IImageViewerEvents Interface

This method is implemented on the client-side. It is called by ABBYY FineReader Engine before splitting images in Image Viewer. The process is invoked, if Split by Line or Split Automatically button is clicked in the Split section of the Image Editor dialog box.

The method delivers to the client information on the specific images which are going to be split, and the regions which will be used for splitting. With the help of this method it is possible to cancel the operation.

See the illustration



HRESULT OnSplitImages(
  IIntsCollection*    PageIndices,
  IRegionsCollection* Regions,
  VARIANT_BOOL*       Cancel


void OnSplitImages(
  IIntsCollection    PageIndices,
  IRegionsCollection Regions,
  out bool          Cancel

Visual Basic .NET

Sub OnReadBlocks( _
  PageIndices As IIntsCollection, _
  Regions As IRegionsCollection, _
  ByRef Cancel As Boolean _


[in] Contains the indices of pages which are going to be split as the IntsCollection object.
[in] Contains the collection of regions which will be used to split images as the RegionsCollection object.
[out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the corresponding function returns E_ABORT.

Return values

[C++ only] If this method returns a value other than S_OK, it indicates that an error occurred on the client-side, and in this case the value of the Cancel parameter is not taken into account.


The client implementation of this method must assure that all exceptions thrown inside the method are caught and handled and no exceptions are propagated outside the method. Propagation of an exception outside the method may lead to unpredictable results (such as program termination).

See also


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.