AddClipRegion Method of the ImageModification Object

AddClipRegion method of the ImageModification Object in the ABBYY FineReader Engine API — Adds a new clipping region to the internal array; coordinates use the relevant color/gray plane or the deskewed black-and-white plane.

This method adds a new clipping region to the internal array of clipping regions of the ImageModification object. To remove all the clipping regions previously added call the IImageModification::ClearClipRegions method. If the modification must be applied to a single color (or gray) plane of the image, coordinates of the region should be specified on this color (gray) plane. If the modification must be applied to the whole ImageModification, the coordinates should be specified on the deskewed black-and-white image plane.

Syntax

C++

HRESULT AddClipRegion( IRegion* Region );

C#

void AddClipRegion( IRegion Region );

Visual Basic .NET

Sub AddClipRegion(Region As IRegion)

Parameters

Region

[in] This parameter of the Region type specifies the clipping region to be added.

Return values

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

Remarks

Clipping regions specify what part of the image will be affected during modification. Only part of image inside the bounding region of the clipping regions is processed, and the part of image inside the bounding region that does not belong to any of the clipping regions, is filled in with the white color.

See also

ImageModification

ClearClipRegions