Region

The field region. It is an area on the image that contains the text for a specific field. A field region is constructed using one or more rectangles.

Region represents a field region on a document image. A region is built from one or more rectangles.

Properties

Name	Type	Access	Description
PageId	string	Read-only	Identifier of the page that contains the region.
Rectangles	Rectangle[]	Read-only	The rectangle set used to make the region.

Methods

AddRectangle

bool AddRectangle(number topLeftX, number topLeftY, number bottomRightX, number bottomRightY);

Adds a rectangle to the region using the four boundary coordinates. Returns true if the rectangle was added.

RemoveRectangle

bool RemoveRectangle(Rectangle rectangle);

Removes the specified rectangle from the region. Returns true if the rectangle was removed.

RemoveAll

void RemoveAll();

Removes all rectangles from the region.

RegionsCollection

A read-only collection of Region objects for a single field.

Methods

AddRegion

Region AddRegion(number pageIndex);

Adds a new region to the field on the specified page. Returns the created Region.

RemoveRegion

void RemoveRegion(Region region);

Removes the specified region.

RemoveAll

void RemoveAll();

Removes all regions from the current field.

Related topics

• Field
• Rectangle
• Object model