OnAnalyzePages Method of the IDocumentViewerEvents Interface

OnAnalyzePages method of the IDocumentViewerEvents Interface in ABBYY FineReader Engine Visual Components on Windows — This method is implemented on the client-side.

This method is implemented on the client-side. It is called by ABBYY FineReader Engine before the start of the page analysis process which has been invoked from Document Viewer in one of the following ways:

• Analyze Page Layout item in the context menu is selected
• Ctrl+E hot key is pressed
• MI_AnalyzeLayout command is called using the DoCommand method of the IDocumentViewer::Commands

It informs the client that an active page is going to be analyzed. With the help of this method it is possible to cancel the operation.

Syntax

C++

HRESULT OnAnalyzePages( VARIANT_BOOL* Cancel );

C#

void OnAnalyzePages( out bool Cancel );

Visual Basic .NET

Sub OnAnalyzePages(ByRef Cancel As Boolean)

Parameters

Cancel

[out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the page 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.

Remarks

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

IDocumentViewerEvents