OnDeleteBlocks Method of the IZoomViewerEvents Interface

OnDeleteBlocks method of the IZoomViewerEvents 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 deleting the blocks in Zoom Viewer, if this process has been invoked in one of the following ways:

• with the help of the Delete Block (MI_ChooseTool_DeleteBlock) tool of Image Viewer
• by calling MI_BlockDelete command in Image Viewer or Zoom Viewer

See the Image Viewer Commands and Zoom Viewer Commands lists to find out how the commands can be called.

Syntax

C++

HRESULT OnDeleteBlocks(
  IIntsCollection* BlocksToDelete,
  VARIANT_BOOL*    Cancel
);

C#

void OnDeleteBlocks(
  IIntsCollection BlocksToDelete,
  out bool       Cancel
);

Visual Basic .NET

Sub OnDeleteBlocks( _
  BlocksToDelete As IIntsCollection, _
  ByRef Cancel As Boolean _
)

Parameters

BlocksToDelete

[in] Contains the indices of blocks that have to be deleted as the IntsCollection object.

Cancel

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

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

IZoomViewerEvents