OnToolAddBlock Method of the IZoomViewerEvents Interface

OnToolAddBlock 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 adding a new block that has been drawn in Zoom Viewer with the help of one of the following tools of Image Viewer:

• Draw Recognition Area (MI_ChooseTool_DrawRecognitionArea)
• Draw Text Area (MI_ChooseTool_DrawTextBlock)
• Draw Table Area (MI_ChooseTool_DrawTableBlock)
• Draw Picture Area (MI_ChooseTool_DrawPictureBlock)
• Draw Background Picture Area (MI_ChooseTool_DrawBackgroundPictureBlock)
• Draw Barcode Area (MI_ChooseTool_DrawBarcodeBlock)

See the description of the Image Viewer Commands to know how these tools can be selected.

It delivers to the client information about the block that has been drawn: its type and region. With the help of this method it is possible to cancel the operation.

Syntax

C++

HRESULT OnToolAddBlock(
  BlockTypeEnum  Type,
  IFRRectangle*  BlockRect,
  VARIANT_BOOL** Cancel
);

C#

void OnToolAddBlock(
  BlockTypeEnum Type,
  IFRRectangle   BlockRect,
  out bool      Cancel
);

Visual Basic .NET

Sub OnToolAddBlock( _
  Type As BlockTypeEnum, _
  BlockRect As IFRRectangle, _
  ByRef Cancel As Boolean _
)

Parameters

Type

[in] Contains the type of the block. See the description of the BlockTypeEnum constants.

BlockRect

[in] Contains the coordinates of the block in pixels. Coordinates are represented by the FRRectangle object. The coordinates are relative to the document image.

Cancel

[out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the block will not be created.

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