OnEditImages Method of the IImageViewerEvents Interface
This method is implemented on the client-side. It is called by ABBYY FineReader Engine before the start of image editing in Image Viewer. The process is invoked if one of the following commands is called:
- MI_DeskewImage
- MI_StraightenTextLines
- MI_ReduceISONoise
- MI_RemoveMotionBlur
- MI_RotateClockwise
- MI_RotateCounterClockwise
- MI_RotateUpsideDown
- MI_FlipHorizontal
- MI_FlipVertical
- MI_InvertImage
The commands can be called using the corresponding buttons on the toolbar (if any), items in the context menu, hot keys or using the DoCommand method of the IImageViewer::Commands. To find which way is available for which command, refer to the Image Viewer Commands list.
The method delivers to the client information on the indices of the pages which are going to be edited, and the command which will be used for editing. With the help of this method it is possible to cancel the operation.
Syntax
C++
HRESULT OnEditImages(
IIntsCollection* PageIndices,
MenuItemEnum MenuItem,
VARIANT_BOOL* Cancel
);
C#
void OnEditImages( IIntsCollection PageIndices, MenuItemEnum MenuItem, out bool Cancel );
Visual Basic .NET
Sub OnEditImages( _ PageIndices As IIntsCollection, _ MenuItem As MenuItemEnum, _ ByRef Cancel As Boolean _ )
Parameters
- PageIndices
- [in] Contains the indices of pages that are going to be edited as the IntsCollection object.
- MenuItem
- [in] Specifies the command which is used for image editing. See the description of the MenuItemEnum constants. The following constants can be the value of this parameter: MI_DeskewImage, MI_StraightenTextLines, MI_ReduceISONoise, MI_RemoveMotionBlur, MI_RotateClockwise, MI_RotateCounterClockwise, MI_RotateUpsideDown, MI_FlipHorizontal, MI_FlipVertical, MI_InvertImage.
- Cancel
- [out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the image will not be edited.
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
17.09.2024 15:14:41