Click or drag to resize

Document Methods

The Document type exposes the following members.

Methods
  NameDescription
Public methodApplyFormTemplate
This method applies a form processing template file to a filled-in form image, when performing Form Data Extraction (FDE).
Public methodApplyPreprocessTemplate
This method performs template-based preprocessing on one or more document pages.
Public methodApplyZoneTemplate
This method can be used to apply a saved zone template to one or more pages in the document.
Public methodCDCount
This method returns the number of custom data streams of the specified type stored in the document.
Public methodCDExport
This method saves an existing piece of custom data stored in the document to an external file specified by the FileName parameter.
Public methodCDGetData
This method retrieves custom data stored in the document.
Public methodCDImport
This method imports custom (also referred as client) data from an external file into the document.
Public methodCDName
This method returns the name of the requested custom data stream of the requested type.
Public methodCDNameEx
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 document.
Public methodCDSetData
This method creates or modifies binary or string custom data streams stored in the document.
Public methodCleanBuffers
Caution note Caution
This API is preliminary and subject to change.
Public methodClearModified
This method sets the Modified property to False.
Public methodClose
The method is used to Close the document and remove it from the Documents collection.
Public methodConvertResults
This method creates the final output document from the recognition results using the specified converter.
Public methodDispose
Public methodEnableUIMode
This method sets the UI mode.
Public methodEquals (Overrides ObjectEquals(Object).)
Public methodExecuteWorkflow
This method executes an OmniPage 15 or 16 compatible workflow.
Public methodGetActivePage
This property returns a reference to the active page of the document, which is always loaded into memory.
Public methodGetBarcodeTypes
This property returns the BarcodeTypes collection object which allows you to individually enable or disable the recognition of particular bar code types.
Public methodGetDocumentProperty
This method sets or returns the property of the document.
Public methodGetDropoutColorWeights
This method retrieves the current value of the drop-out color weights.
Public methodGetEngine
Returns the Engine object.
Public methodGetFindText
Page is a valid zero-based page index or FINDTEXT_FIRST for the first page or FINDTEXT_LAST for the last page.
Public methodGetHashCode (Overrides ObjectGetHashCode.)
Public methodGetPages
This property returns the Pages collection, containing the document Page objects.
Public methodGetPreprocessTemplate
This method returns the name of the selected preprocess template.
Public methodGetRecognitionLanguages
This property returns the collection of available recognition languages that can be switched on/off independently.
Public methodGetSettingManager
This property returns the SettingManager object, which allows you to manage your application-specific settings together with the Engine settings in a thread-safe manner.
Public methodGetStatistics
This property returns the Statistics object of the document.
Public methodGetThumbnailImgInfo
This method retrieves the thumbnail information currently being used when the engine generates thumbnail images (II_THUMBNAIL image of the Image object).
Public methodGetTrainingData
This method returns the name of the currently selected training data.
Public methodGetUserDictionary
This method returns the name and section information for the currently selected user dictionary.
Public methodGetVerticalDictionaries
This property returns the collection of available vertical (professional) dictionaries.
Public methodGetWFHandler
This property returns the workflow handler interface.
Public methodGetZoneTemplate
This method returns the name of the selected zone template.
Public methodImagePreprocess
This method performs image preprocessing according to the current document settings.
Public methodLoadBitmap
This method returns a reference to the created Page.
Public methodLoadImage
If a single page was loaded, this method returns a reference to the loaded Page object.
Public methodLoadSettings
This method loads a previously saved document setting file and applies all the loaded settings to the document.
Public methodLocateZones
This method automatically locates all OCR zones on the related pages and builds the OCRZone collection using auto-zoning.
Public methodOpen
This method can be used to open an existing IPRO document file.
Public methodProcessPages
This method processes one or more input image files and creates the output document file(s) in a single step.
Public methodRecognize
This method recognizes one or more document pages.
Public methodSave
This method is used to save the document to an IPRO document file.
Public methodSaveImages
This method saves one more pages of the document into external image file(s).
Public methodSaveSettings
This method saves the current document settings into a setting file specified by the SettingFile parameter. If SettingFile already exists, it is overwritten.
Public methodScanImage
If a single page was scanned, this method returns a reference to the scanned Page object.
Public methodSetDefaults
This method resets all document level settings to their original, default values.
Public methodSetDocumentProperty
This method sets or returns the property of the document.
Public methodSetDropoutColorWeights
This method sets the weights used to calculate the gray-level intensity values from the color components during binarization. By default the value of these weights are (77, 150, 29).
Public methodSetPreprocessTemplate
The method selects a preprocess template for the Document object.
Public methodSetThumbnailImgInfo
This method sets the thumbnail information which is used when the engine generates thumbnail images (II_THUMBNAIL image of the Image object).
Public methodSetTrainingData
This method selects training data to be used during recognition.
Public methodSetUserDictionary
This method selects a user dictionary for the document to use during recognition.
Public methodSetZoneTemplate
This method selects a zone template for the Document object.
Top
See Also