OnRenumberPages Method of the IDocumentViewerEvents Interface

OnRenumberPages 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 opening the Renumber Pages dialog box in Document Viewer. The process can be invoked by calling the MI_RenumberPages command. See the description of the Document Viewer commands to know how this command can be called.

It informs the client that pages in the document are going to be renumbered. With the help of this method it is possible to cancel the operation.

Syntax

C++

HRESULT OnRenumberPages( VARIANT_BOOL* Cancel );

C#

void OnRenumberPages( out bool Cancel );

Visual Basic .NET

Sub OnRenumberPages(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, pages will not be renumbered.

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