Modify Method of the ImageDocument Object

Modify method of the ImageDocument Object in the ABBYY FineReader Engine API — Applies all modifications defined by an ImageModification object (clipping, painting, inverting, replacing pixels, removing garbage, stretching).

This method modifies the current ImageDocument. All modifications defined by the ImageModification object are possible.

To perform modification, do the following:

1. Create an ImageModification object with the help of the CreateImageModification method of the Engine object.
2. Specify the necessary parameters.
3. Call the Modify method with this object as an input parameter. The actual change takes place only when you call this method.
4. Save the changes using the IImageDocument::SaveModified method.

Modifications to the image are not saved until the IImageDocument::SaveModified method is called. If the ImageDocument object is released before a call to this method, the modifications are not saved.

All blocks must be removed from page layout before this method call. Call the ILayoutBlocks::DeleteAll method for ILayout::Blocks and ILayout::BlackSeparators , and ILayout::VisualBlocks (Win) collections of the corresponding layout.

Syntax

C++

HRESULT Modify( IImageModification* Modification );

C#

void Modify( IImageModification Modification );

Visual Basic .NET

Sub Modify(Modification As IImageModification)

Parameters

Modification

[in] This variable of the ImageModification type specifies the transformations that are to be performed upon the ImageDocument object.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

Remarks

All the information about the initial image will be lost after the method call.

This method applies modifications to the black-and-white, gray, and color image planes of the ImageDocument. All the other pages are deleted from the ImageDocument. They will be created upon demand.

See also

ImageModification