Click or drag to resize

Page Class
Specifies the index of the page that contains the found text.
Inheritance Hierarchy

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
Copy
public class Page : IproPlusClass, IDisposable

The Page type exposes the following members.

Properties
  NameDescription
Public propertyActive
This property returns whether or not a given page is the active one in the document.
Public propertyBookmarked
This property sets or gets the bookmarked state of a page.
Public propertyClassificationInfo
Caution note Caution
This API is preliminary and subject to change.
Public propertyFindAdditionalZones
This property determines whether additional zones will be located on the page areas not covered by any UserZones.
Public propertyFrameCount
This property returns the number of frames found during recognition.
Public propertyKeepZoneOrder
This property gets or sets the zone order.
Public propertyLanguage
This property returns the language of the object.
Public propertyNote
Use this property to get or set a user note for a page.
Public propertyPageNumber
This property returns the page index of the page object within the parent document.
Public propertyPreprocessed
This property returns whether the image of the page object is preprocessed or not.
Public propertyPreprocessInfo
This property returns the preprocess-related information of an object.
Public propertyRecognized
This property returns True, if the page has been recognized, which means that a recognition result is available for the page.
Public propertySelected
Use this property to get or set whether this page is selected or not.
Public propertyState
The returned value is a combination of the PAGESTATE enumeration values.
Public propertyUniqueID
Use this property to set the Unique ID of an object.
Top
Methods
  NameDescription
Public methodApplyFormTemplate
This method applies a previously created form template to the page.
Public methodApplyPreprocessTemplate
This method performs template-based preprocessing on one or more document pages.
Public methodApplyZoneTemplate
This method applies a previously created zone template to the page.
Public methodCDCount
This method returns the number of custom data streams of the specified type stored in the page.
Public methodCDGetData
This method returns or sets a piece of custom data stored in the page.
Public methodCDName
This method returns the name of the requested custom data stream of the requested type.
Public methodCDRemove
This method deletes a custom data stream from the page.
Public methodCDSetData
This method creates or modifies binary or string custom data streams stored in the page.
Public methodCharacterArray
This property returns an array of characters on the page in the form of an IPROCHARACTER array.
Public methodCharacters
This property can be used from any supported development environment but was provided for Visual Basic programmers in particular.
Public methodCheckFormTemplate
Caution note Caution
This API is preliminary and subject to change.
Public methodConvertResults
This function converts the recognition results of the page object into a final output document file.
Public methodConvertToDirectTXT
This method recognizes and converts a single page into one of the supported direct text output formats.
Public methodCopyPage
This method copies this page to another document.
Public methodCreateFormTemplate
This method creates a template for form processing based on an unfilled, master form.
Public methodDetectDropoutColorWeights
This method calculates the best weights that can be used for drop-out color binarization.
Public methodDetectFillingMethod
This method tries to detect the filling method of the existing user zone set.
Public methodDispose
Releases all resources used by the Page
Public methodEquals (Overrides ObjectEquals(Object).)
Public methodGetAppliedTemplate
Caution note Caution
This API is preliminary and subject to change.
Public methodGetBackgroundZones
This property returns the collection of background zones.
Public methodGetClassificationProject
Caution note Caution
This API is preliminary and subject to change.
Public methodGetDocument
Returns the parent Document object.
Public methodGetEngine
Returns the Engine object.
Public methodGetFrameInfo
This method returns position and style information about frames found during the recognition process.
Public methodGetHashCode (Overrides ObjectGetHashCode.)
Public methodGetImage
This property returns the Image object.
Public methodGetOCRZones
This property returns the collection of zones, which were created by the engine during zone location.
Public methodGetStatistics
This property returns the Statistics object of the page.
Public methodGetUserZones
This property returns the collection of zones created by the user. These will be used during recognition.
Public methodImagePreprocess
This method performs image preprocessing if the given page is not already preprocessed (the Preprocessed property is False).
Public methodLocateZones
This method automatically locates all OCR zones on the related pages and builds the OCRZone collection for each page using auto-zoning.
Public methodMovePage
This method moves this page to another document.
Public methodRecognize
This method invokes recognition for the page object.
Public methodRecommendUserZone
This method locates a likely user zone based on a coordinate giving a location on the page.
Public methodRemoveLines
Calling this method removes the vertical and horizontal lines from the II_BW image and returns them as a RemovedLines collection.
Public methodSaveFormTemplate
This method saves a form template constructed using the CreateFormTemplate method.
Public methodSaveImage
This method saves an image of the page to an external image file.
Public methodSaveImageArea
This method saves an image of the page to an external image file.
Top
See Also