IPage - ABBYY Documentation

Represents a page.

Some methods and properties of this object are not available on the Web Verification Station for checking rules locally. The methods and properties that are not supported are marked with an asterisk (*).

Methods

Method	Description
`ApplyImageEnhancementProfile( name : string )` *	Applies the set enhancement profile to an image. If applying a profile creates new pages, they are added to the document after the current page. For an example, see Apply an enhancement profile to photo images.
`MarkAsAnnex( )` *	Marks the page as an annex that does not require recognition.
`ReplaceImage( newPicture : IPictureObject )` *	Replaces the page image with a new one. Create the new image in one of three ways. Edit another IPictureObject object, or load it from a file with the FCTools `LoadImage` method. The third way is to build it from an in-memory bitmap, such as a .NET `System.Drawing.Image`, with the FCTools `PictureFromHBitmap` method.
`RevertToOriginalImage( )` *	Reverts to the original page image. This method can be called only if the `HasOriginalImage` property is set to `true`. For an example, see Revert to the original page image.
`SaveAs( filename : string, [optional] options : IExportImageSavingOptions )` *	Saves the page image depending on saving options. If options are not specified, the image is saved as `*.tif`. This is an internal field that requires loading the object into memory.
`SaveSourceFile( )` *	Saves the source file from which the page image originated to the specified file. This method can be called only if the source file was saved. You can check whether the source file was saved using the `SourceFileGUID` property. For more information, see Sample scripts describing export.
`SaveXmlTextToFile( filename : string )` *	Saves all of the text on the page as an XML file to the specified folder.
`SaveXmlTextToFileStorage( )` *	Saves all of the text on the page as an XML file to the folder of the batch in the file storage.

Properties

Name	Type	Access	Description
AsBatchItem *	IBatchItem	Read-only	Converts the page into an IBatchItem object.
Attachments *	IUserAttachments	Read-only	User attachments.
Comment *	string	Read-only	The page description.
Document *	IDocument	Read-only	The document that contains the page.
ExcludedFromDocumentImage *	bool	Read/write, mutable (can be modified even in scripts with read-only permissions)	Applies during export of the document image. Indicates that the current page image should not be exported when exporting the whole document. This is an internal field that requires loading the object into memory.
FullText *	string	Read-only	The recognized text on the page.
FullTextCharRects *	IRects	Read-only	Rectangles of characters from `FullText`.
HasOriginalImage *	bool	Read-only	Indicates whether the original page image is available.
Id	string	Read-only	The page identifier.
ImageSource *	string	Read-only	The source of an image. If the image was imported from a file, this property contains the path to the file. If the image was received from a scanner, `ImageSource` contains the name of the source. Contains an empty value if the image was imported using a custom import.
ImageSourceFileSubPath *	string	Read-only	The path of the source image relative to the root of the Hot Folder or the folder it was imported from.
ImageSourcePageNumber *	int	Read-only	The number of the source page in the file.
ImageSourceType *	string	Read-only	The string `File`, `Scanner`, or `Custom` depending on the source.
Index *	int	Read-only	The page index in the document.
IsAnalyzed *	bool	Read-only	Specifies whether the page is analyzed.
IsResultClassConfident *	bool	Read/write	Shows whether the page was confidently classified.
MatchedSection *	IMatchedSectionInfo	Read-only	Detailed information about the section which is matched on the page. If there are no matched sections on the page, the value is `null`.
Picture *	IPictureObject	Read-only	The page image. This is an internal field that requires loading the object into memory.
Rect *	IRect	Read-only	The rectangle of the page. This is an internal field that requires loading the object into memory.
ReferenceClassName *	string	Read-only	The reference class of the page.
ResultClassName *	string	Read/write	The name of the class that is assigned to the page.
SectionName *	string	Read-only	The document section name.
SourceFileGUID *	string	Read-only	The identifier of a source file of a document. Contains an empty string if the source file was not saved.
SourceImageRotation *	int	Read-only	The angle (in degrees) to which the source page image was rotated. Possible values: `0`, `90`, `180`, `270`. For pages rotated counter-clockwise, the value of clockwise rotation is returned (for example, for an image rotated 90° counter-clockwise, `270` is returned). The property is available only if the document that contains the page is open. This is an internal field that requires loading the object into memory. For the images this property applies to, see Source image rotation.

Source image rotation

The SourceImageRotation property returns the rotation angle for images:

Imported from a Hot Folder
Loaded in the Project Setup Station or in the rich Verification Station
Rotated during recognition
Rotated manually in rich and remote stations
Rotated manually in the Web Verification Station or during verification in the Web Capture Station

The property ignores the rotation value for images:

Rotated by scripts
Rotated in the (Web-) Scanning Station or during scanning in the Web Capture Station
Rotated automatically when correcting image skew

Apply an enhancement profile to photo images

The following script for a custom processing stage applies the Photo enhancement profile to all images of the photo type:

foreach( IPage page in Document.Pages )
{
    IPictureObject picture = page.Picture;
    if( picture.IsPhoto() )
    {
        page.ApplyImageEnhancementProfile("Photo");
    }
}

Revert to the original page image

The following script returns the operator to the original page image on the Verification Station when the Store original image during processing option is selected:

foreach( IPageItem pageItem in MainWindow.Selection.PageItems) {
    pageItem.TaskWindow.CloseEditorWindow();
    pageItem.TaskWindow.OpenDocument(  pageItem.DocumentItem.Document );
    IPage page = pageItem.Page;
    if ( page.HasOriginalImage )
        page.RevertToOriginalImage();
    pageItem.TaskWindow.CloseDocument(  pageItem.DocumentItem.Document );
}

​Methods

​Properties

​Source image rotation

​Apply an enhancement profile to photo images

​Revert to the original page image

Methods

Properties

Source image rotation

Apply an enhancement profile to photo images

Revert to the original page image