Document Methods |
The Document type exposes the following members.
Name | Description | |||
---|---|---|---|---|
ApplyFormTemplate |
This method applies a form processing template file to a filled-in form image, when performing Form Data Extraction (FDE). | |||
ApplyPreprocessTemplate |
This method performs template-based preprocessing on one or more document pages. | |||
ApplyZoneTemplate |
This method can be used to apply a saved zone template to one or more pages in the document. | |||
CDCount |
This method returns the number of custom data streams of the specified type stored in the document. | |||
CDExport |
This method saves an existing piece of custom data stored in the document to an external file specified by the FileName parameter. | |||
CDGetData |
This method retrieves custom data stored in the document. | |||
CDImport |
This method imports custom (also referred as client) data from an external file into the document. | |||
CDName |
This method returns the name of the requested custom data stream of the requested type. | |||
CDNameEx |
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 document. | |||
CDSetData |
This method creates or modifies binary or string custom data streams stored in the document. | |||
CleanBuffers |
This API is preliminary and subject to change. | |||
ClearModified |
This method sets the Modified property to False.
| |||
Close |
The method is used to Close the document and remove it from the Documents collection.
| |||
ConvertResults |
This method creates the final output document from the recognition results using the specified converter. | |||
Dispose | ||||
EnableUIMode |
This method sets the UI mode.
| |||
Equals | (Overrides ObjectEquals(Object).) | |||
ExecuteWorkflow |
This method executes an OmniPage 15 or 16 compatible workflow. | |||
GetActivePage |
This property returns a reference to the active page of the document, which is always loaded into memory. | |||
GetBarcodeTypes |
This property returns the BarcodeTypes collection object which allows you to individually enable or disable the recognition of
particular bar code types. | |||
GetDocumentProperty |
This method sets or returns the property of the document.
| |||
GetDropoutColorWeights |
This method retrieves the current value of the drop-out color weights. | |||
GetEngine |
Returns the Engine object.
| |||
GetFindText |
Page is a valid zero-based page index or FINDTEXT_FIRST for the first page or FINDTEXT_LAST for the last page. | |||
GetHashCode | (Overrides ObjectGetHashCode.) | |||
GetPages |
This property returns the Pages collection, containing the document Page objects.
| |||
GetPreprocessTemplate |
This method returns the name of the selected preprocess template. | |||
GetRecognitionLanguages |
This property returns the collection of available recognition languages that can be switched on/off independently. | |||
GetSettingManager |
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. | |||
GetStatistics |
This property returns the Statistics object of the document.
| |||
GetThumbnailImgInfo |
This method retrieves the thumbnail information currently being used when the engine generates thumbnail images (II_THUMBNAIL image
of the Image object). | |||
GetTrainingData |
This method returns the name of the currently selected training data. | |||
GetUserDictionary |
This method returns the name and section information for the currently selected user dictionary. | |||
GetVerticalDictionaries |
This property returns the collection of available vertical (professional) dictionaries. | |||
GetWFHandler |
This property returns the workflow handler interface. | |||
GetZoneTemplate |
This method returns the name of the selected zone template.
| |||
ImagePreprocess |
This method performs image preprocessing according to the current document settings. | |||
LoadBitmap |
This method returns a reference to the created Page. | |||
LoadImage |
If a single page was loaded, this method returns a reference to the loaded Page object. | |||
LoadSettings |
This method loads a previously saved document setting file and applies all the loaded settings to the document. | |||
LocateZones |
This method automatically locates all OCR zones on the related pages and builds the OCRZone collection using auto-zoning. | |||
Open |
This method can be used to open an existing IPRO document file. | |||
ProcessPages |
This method processes one or more input image files and creates the output document file(s) in a single step. | |||
Recognize |
This method recognizes one or more document pages. | |||
Save |
This method is used to save the document to an IPRO document file. | |||
SaveImages |
This method saves one more pages of the document into external image file(s). | |||
SaveSettings |
This method saves the current document settings into a setting file specified by the SettingFile parameter. If SettingFile already exists, it is overwritten.
| |||
ScanImage |
If a single page was scanned, this method returns a reference to the scanned Page object. | |||
SetDefaults |
This method resets all document level settings to their original, default values. | |||
SetDocumentProperty |
This method sets or returns the property of the document.
| |||
SetDropoutColorWeights |
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). | |||
SetPreprocessTemplate |
The method selects a preprocess template for the Document object. | |||
SetThumbnailImgInfo |
This method sets the thumbnail information which is used when the engine generates thumbnail images (II_THUMBNAIL image of the Image object). | |||
SetTrainingData |
This method selects training data to be used during recognition. | |||
SetUserDictionary |
This method selects a user dictionary for the document to use during recognition. | |||
SetZoneTemplate |
This method selects a zone template for the Document object.
|