Properties
| Name | Type | 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
| Name | Description |
|---|---|
| AddRectangle(number topLeftX, number topLeftY, number bottomRightX, number bottomRightY); | Adds a rectangle to the region. The rectangle is specified using 4 coordinates (left, top, right, bottom). Returns true if the rectangle was successfully added. |
| RemoveRectangle(Rectangle rectangle); | Deletes the rectangle specified using the Rectangle object. Returns true if the rectangle was successfully deleted. |
| RemoveAll(); | Deletes all rectangles of the region. |
RegionsCollection
The read-only collection of Region objects that provides access to the regions associated with a single field.Methods
| Name | Description |
|---|---|
| AddRegion(number pageIndex); | Adds a new region to the field. The region is created on a specified page. This method returns the Region object that was created. |
| RemoveRegion(Region region); | Deletes the specified region. |
| RemoveAll(); | Deletes all regions of the current field. |