Page Class |
Namespace: Kofax.OmniPageCSDK.IproPlus
The Page type exposes the following members.
Name | Description | |||
---|---|---|---|---|
Active |
This property returns whether or not a given page is the active one in the document. | |||
Bookmarked |
This property sets or gets the bookmarked state of a page. | |||
ClassificationInfo |
This API is preliminary and subject to change. | |||
FindAdditionalZones |
This property determines whether additional zones will be located on the page areas not covered by any UserZones. | |||
FrameCount |
This property returns the number of frames found during recognition. | |||
KeepZoneOrder |
This property gets or sets the zone order. | |||
Language |
This property returns the language of the object.
| |||
Note |
Use this property to get or set a user note for a page. | |||
PageNumber |
This property returns the page index of the page object within the parent document.
| |||
Preprocessed |
This property returns whether the image of the page object is preprocessed or not.
| |||
PreprocessInfo |
This property returns the preprocess-related information of an object.
| |||
Recognized |
This property returns True, if the page has been recognized, which means that a recognition result is available for the page. | |||
Selected |
Use this property to get or set whether this page is selected or not. | |||
State |
The returned value is a combination of the PAGESTATE enumeration values.
| |||
UniqueID |
Use this property to set the Unique ID of an object.
|
Name | Description | |||
---|---|---|---|---|
ApplyFormTemplate |
This method applies a previously created form template to the page. | |||
ApplyPreprocessTemplate |
This method performs template-based preprocessing on one or more document pages. | |||
ApplyZoneTemplate |
This method applies a previously created zone template to the page. | |||
CDCount |
This method returns the number of custom data streams of the specified type stored in the page. | |||
CDGetData |
This method returns or sets a piece of custom data stored in the page. | |||
CDName |
This method returns the name of the requested custom data stream of the requested type. | |||
CDRemove |
This method deletes a custom data stream from the page. | |||
CDSetData |
This method creates or modifies binary or string custom data streams stored in the page. | |||
CharacterArray |
This property returns an array of characters on the page in the form of an IPROCHARACTER array. | |||
Characters |
This property can be used from any supported development environment but was provided for Visual Basic programmers in particular. | |||
CheckFormTemplate |
This API is preliminary and subject to change. | |||
ConvertResults |
This function converts the recognition results of the page object into a final output document file. | |||
ConvertToDirectTXT |
This method recognizes and converts a single page into one of the supported direct text output formats. | |||
CopyPage |
This method copies this page to another document. | |||
CreateFormTemplate |
This method creates a template for form processing based on an unfilled, master form. | |||
DetectDropoutColorWeights |
This method calculates the best weights that can be used for drop-out color binarization. | |||
DetectFillingMethod |
This method tries to detect the filling method of the existing user zone set. | |||
Dispose | Releases all resources used by the Page | |||
Equals | (Overrides ObjectEquals(Object).) | |||
GetAppliedTemplate |
This API is preliminary and subject to change. | |||
GetBackgroundZones |
This property returns the collection of background zones. | |||
GetClassificationProject |
This API is preliminary and subject to change. | |||
GetDocument |
Returns the parent Document object.
| |||
GetEngine |
Returns the Engine object.
| |||
GetFrameInfo |
This method returns position and style information about frames found during the recognition process. | |||
GetHashCode | (Overrides ObjectGetHashCode.) | |||
GetImage |
This property returns the Image object.
| |||
GetOCRZones |
This property returns the collection of zones, which were created by the engine during zone location.
| |||
GetStatistics |
This property returns the Statistics object of the page.
| |||
GetUserZones |
This property returns the collection of zones created by the user. These will be used during recognition.
| |||
ImagePreprocess |
This method performs image preprocessing if the given page is not already preprocessed (the Preprocessed property is False). | |||
LocateZones |
This method automatically locates all OCR zones on the related pages and builds the OCRZone collection for each page using auto-zoning. | |||
MovePage |
This method moves this page to another document. | |||
Recognize |
This method invokes recognition for the page object. | |||
RecommendUserZone |
This method locates a likely user zone based on a coordinate giving a location on the page. | |||
RemoveLines |
Calling this method removes the vertical and horizontal lines from the II_BW image and returns them as a RemovedLines collection. | |||
SaveFormTemplate |
This method saves a form template constructed using the CreateFormTemplate method. | |||
SaveImage |
This method saves an image of the page to an external image file. | |||
SaveImageArea |
This method saves an image of the page to an external image file. |