Page Object (IPage Interface)
This object corresponds to a page of a document. A page represents an image of a document page and results of its processing. It provides a set of properties and methods for working with page image and managing page state. All the pages of the document are represented by the Pages object.
The whole page can be considered as the top-level block which contains all the blocks of the page. The Page object supports the IBlock interface. You may treat this object as the Block object.
Properties
| Name | Type | Description |
|---|---|---|
| AsBatchItem | BatchItem, read-only | Specifies the Page as a batch item. If the document is not a batch item this property is NULL. |
| AsClassificationTrainingPage | ClassificationTrainingPage, read-only | Provides access to the corresponding classification training object. |
| Blocks | Blocks, read-only | Returns the collection of page blocks. |
| ErrorText | String, read-only | Returns the text description of the error which occurred while processing the page. |
| Id | Integer, read-only | Returns the identifier of the page. |
| Index | Integer, read-only | Returns the index of the page in the collection of pages. |
| Image | ImageDocument, read-only | Provides access to the image of the page. The value of this property can be changed. If you do not want to change the image of the page you can use the ReadOnlyImage property. |
| ImageRotation | RotationTypeEnum, read-only | Specifies rotation that was performed upon the page image after opening or after the last call to IImageDocument::SaveModified method. |
| IsAnalyzed | Boolean, read-only | Specifies whether the page has been analyzed. |
| IsRecognized | Boolean, read-only | Specifies whether the page has been recognized. |
| KeyValue | FieldValue, read-only | Returns the key field value. The key field enables automatic checking of page assembly into documents. The values of key fields must be identical on all pages of the same document. |
| Name | String, read-only | Returns the name of the page. |
| OriginalImagePath | String, read-only | Returns the full path to the original image of the page. |
| PageDefinition | PageDefinition, read-only | Returns the Document Definition page applied to the document page. |
| ReadOnlyImage | ImageDocument, read-only | Provides access to the read-only image of the page. The value of this property cannot be changed. If you want to change the image of the page you should use the Image property. |
| SectionDefinition | SectionDefinition, read-only | Returns the section definition which contains the page definition applied to the document page. |
| SourceImageInfo | SourceImageInfo, read-only | Contains information about the source image. |
| Type | PageTypeEnum, read-only | Specifies the type of the page. |
| WarningText | String, read-only | Returns the text description of the warning which occurred while processing the page. |
Methods
| Name | Description |
|---|---|
| ChangeResolution | Changes resolution of the page image. |
| ExtractTextRegions | Extracts background text regions on the page. |
| GetTextsFromCache | Gets full-text recognition results. |
| SetFieldRegion | Specifies field region. |
| TransformImage | Performs specified transformations of the page image. |
Related objects
Output parameter
This object is the output parameter of the Item method of the Pages object.
Input parameter
This object is the input parameter of the following methods:
- MatchBlock method of the Block object
- AddNewFromPage method of the Documents object
Samples
This method is used in the following code samples: Invoices Processing and Training.
See also
15.08.2023 13:19:30