OnAnalyzeRegion Method of the IImageViewerEvents Interface

This method is implemented on the client-side. It is called by ABBYY FineReader Engine before the start of the block analysis process which has been invoked from Image Viewer by calling the MI_AnalyzeLayoutInBlock command. For the ways how this command can be called see the Image Viewer Commands list.

The method delivers to the client information about the region which is going to be analyzed. With the help of this method it is possible to cancel the operation.



HRESULT OnAnalyzeRegion(
  IRegion*      Region,


void OnAnalyzeRegion(
  IRegion   Region,
  out bool Cancel

Visual Basic .NET

Sub OnAnalyzeRegion( _
  Region As IRegion, _
  ByRef Cancel As Boolean _


[in] Contains the region which is going to be analyzed as the Region object.
[out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the region will not be analyzed.

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




03.07.2024 8:50:43

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.