OnToolEraseRect Method of the IImageViewerEvents Interface

This method is implemented on the client-side. It is called by ABBYY FineReader Engine before erasing a part of an image, if this process has been invoked with the help of the MI_ChooseTool_Eraser command of Image Viewer. For the ways how this command can be called see the Image Viewer Commands list.

The method delivers to the client information on the page which is going to be edited, and the coordinates of the erasing rectangle. With the help of this method it is possible to cancel the operation.

See the illustration



HRESULT OnToolEraseRect(
  IFRRectangle* Rect,
  int           PageIndex,


void OnToolEraseRect(
  IFRRectangle Rect,
  int         PageIndex,
  out bool    Cancel

Visual Basic .NET

Sub OnToolEraseRect( _
  Rect As IFRRectangle, _
  PageIndex As Integer, _
  ByRef Cancel As Boolean _


[in] Contains the coordinates of the erasing rectangle as the FRRectangle object. The coordinates are specified in pixels relative to the document image.
[in] Specifies the index of the page in the document.
[out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the image area inside the erasing rectangle will not be deleted.

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.