OnProgress Method of the IDocumentViewerEvents Interface

OnProgress 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 during analysis or recognition of the active page in Document Viewer. The process can be invoked in one of the following ways:

• using the commands of Document Viewer:
  • MI_Read
  • MI_AnalyzeLayout

To find how these commands can be called, refer to the Document Viewer Commands list.

• using the following commands of Image Viewer, synchronized with Document Viewer:
  • MI_Read
  • MI_ReadBlock
  • MI_AnalyzeLayout
  • MI_AnalyzeLayoutInBlock

To find how these commands can be called, refer to the Image Viewer Commands list.

• using the following commands of Zoom Viewer, synchronized with Image Viewer:
  • MI_Read
  • MI_ReadBlock
  • MI_AnalyzeLayout
  • MI_AnalyzeLayoutInBlock

To find how these commands can be called, refer to the Zoom Viewer Commands list.

• via FineReader Engine API

It delivers to the client approximate percentage of the operation. Its implementation may show a progress indicator. Process any system messages to help prevent the application from appearing unresponsive during long operations. This can be useful in applications with a user interface. With the help of this method it is possible to cancel the operation.

Syntax

C++

HRESULT OnProgress(
  int           Percentage,
  VARIANT_BOOL* Cancel
);

C#

void OnProgress(
  int      Percentage,
  out bool Cancel
);

Visual Basic .NET

Sub OnProgress( _
  Percentage As Integer, _
  ByRef Cancel As Boolean _
)

Parameters

Percentage

[in] Contains the percent of the work currently done. It is in the range from 0 to 100.

Cancel

[out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the analysis or recognition process will be aborted.

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

DocumentViewer

IDocumentViewerEvents