OnCropImages Method of the IImageViewerEvents Interface

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

The method delivers to the client the indices of the pages which are going to be cropped, and the coordinates of the cropping rectangle. With the help of this method it is possible to cancel the operation.

See the illustration



HRESULT OnCropImages(
  IIntsCollection* PageIndices,
  IFRRectangle*    Rect,
  VARIANT_BOOL*    Cancel


void OnCropImages(
  IIntsCollection PageIndices,
  FRRectangle    Rect,
  out bool       Cancel

Visual Basic .NET

Sub OnCropImages( _
  PageIndices As IIntsCollection, _
  Rect As FRRectangle, _
  ByRef Cancel As Boolean _


[in] Contains the indices of pages which are going to be cropped as the IntsCollection object.
[in] Contains the cropping rectangle as the FRRectangle object. The coordinates are specified in pixels relative to the document image.
[out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, pages will not be cropped.

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.