Document Class |
The Document object represents an IPRO document which encapsulates the data and the parameters required during OCR-related procedures.
Inheritance HierarchyNamespace: Kofax.OmniPageCSDK.IproPlus
Assembly: Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
SyntaxThe Document type exposes the following members.
Properties| Name | Description | |||
|---|---|---|---|---|
 | Active |
This method allows you to get or set the active item.
| ||
| AutoZoning_Column |
This property is used to modify the behavior of Auto-zoning. | ||
| AutoZoning_Form |
This property is used to modify the behavior of auto-zoning. | ||
| AutoZoning_Graphics |
This property is used to modify the behavior of Auto-zoning. | ||
| AutoZoning_Table |
This property is used to modify the behavior of Auto-zoning. | ||
| Binarization |
Use this property to get or set the secondary image conversion mode for the Document object. | ||
| Brightness |
Use this property to get or set the brightness value for the Document object. | ||
| BrightnessThreshold |
Use this property to get or set the threshold value for an image conversion to a B/W image. | ||
| Check |
Use this property to enable or disable the recognition checking subsystem at document level. | ||
| Conversion |
Use this property to get or set the primary image conversion mode. | ||
| Correction |
Use this property to enable or disable the document-level correction of the checking subsystem. | ||
| DecompMethod |
Use this property to get or set which page parser algorithm will be used during auto-zoning. | ||
| DefaultFillingMethod |
Use this property to get or set the default filling method for the document. | ||
| DefaultRecognitionModule |
Use this property to get or set the default recognition module used during recognition. | ||
| Deskew |
Use this property to get or set which image deskewing mode will be used during image preprocessing. | ||
| DespeckleMode |
Use this property to get or set the de-speckle mode used during image preprocessing. | ||
| DownSample |
This property switches on or off the resolution reducing mode during image preprocessing. | ||
| FaxCorrection |
Use this property to get or set the fax correction for image preprocessing. | ||
| FileName |
This property returns the full qualified path to the IPRO document file associated with the Document object. If the document has not yet been saved, an empty string is returned.
| ||
| Filter |
This property is used to narrow the Language environment (the sum of RecognitionLanguages and
LanguagePlus enabled characters). Available values are listed under the CHR_FILTER Enumeration topic. | ||
| FilterPlus |
This property is used to get or set the FilterPlus characters. | ||
| FindBarZones |
This API is preliminary and subject to change. | ||
| HNRBoxHeight |
Use this property to get or set the expected character heights in 1/1200th of an inch for the hand printed numerals recognition module (RM_HNR). | ||
| HNRBoxSpace |
Returns or sets the expected leading spaces in 1/1200th of an inch for the hand printed numerals recognition module (RM_HNR). | ||
| HNRBoxWidth |
Returns or sets the expected character widths in 1/1200th of an inch for the hand printed numerals recognition module (RM_HNR). | ||
| HNRSpaceIncluded |
Use this property to get or set whether the hand printed numerals recognition module (RM_HNR) will report detected spaces between characters. | ||
| HNRStyle |
Use this property to get or set the behavior of the hand printed numerals recognition module (RM_HNR). | ||
| Inversion |
Use this property to get or set which image inversion mode will be used during image preprocessing steps. | ||
| KeepOCRImage |
This property is used to control whether the OCR image (II_OCR) is to be kept after recognition. | ||
| KeepOriginalImage |
By default, the original (II_ORIGINAL), image for any page in the document is not preserved by the page object. | ||
| LanguagePlus |
This property is used to get or set the LanguagesPlus characters for the Document object. | ||
| LegalPleading |
Use this property to control the Legal Pleading format.
| ||
| LookForHeaderFooter |
Use this property if you want to control the handling of header and footer information during output generation. | ||
| LookForHyperlinks |
Use this property if you want to control searching for hyperlinks during recognition. | ||
| MissingSymbol |
Use this property to get or set the value of the "missing" symbol. | ||
| Modified |
This property returns True if a document setting or page data has been modified by any method calls or by setting a property value since the Document object was last saved.
| ||
| MORFax |
This property is used to switch on or off the fax handling feature of the MOR multi-lingual recognition module. | ||
| NongriddedTableDetect |
Use this property to get or set non-gridded table detection during auto-zoning. | ||
| OCRThreadCount |
Use this property to get or set the maximum number of OCR threads that can be launched in parallel during a single Recognize call. | ||
| OMRFill |
Use this property to get or set resolution of the optical mark recognition module. | ||
| OMRFrame |
Use this property to get or set the frame detection method used during OMR optical mark recognition. | ||
| OMRSensitivity |
Use this property to get or set the mark sensitivity level used during the OMR optical mark recognition. | ||
| RejectionSymbol |
Use this property to get or set the code used for the rejection symbol. | ||
| ResEnhancement |
Use this property to get or set the resolution enhancement mode. | ||
| RetainColors |
Use this property to get or set retain color behavior in recognition. | ||
| Rotation |
Use this property to get or set the image rotation mode during image preprocessing. | ||
| SingleLanguageDetection |
Use this property to check the used language.
| ||
| Slope |
Use this property to get or set the skew (slope value). | ||
| SpellLanguage |
Use this property to get or set the spelling language for document level spell checking. | ||
| Title |
Use this method to get or set the title of the object.
| ||
| TradeOff |
Use this property to get or set which recognition trade-off setting will be used during the recognition of the document. | ||
| UILang |
Use this method to get or set the current user interface language ID.
| ||
| UniqueID |
Use this property to get the unique ID of an item.
| ||
| WindowHandle |
This property is used to get or set the handle to the Document object's parent window.
| ||
| WorkingFileName |
Use this method to get the working file name.
| ||
| ZoningFlags |
Use this method to get or set zoning flags for the object.
|
CautionMethods| 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 | Releases all resources used by the Document | ||
| EnableUIMode |
This method sets the UI mode.
| ||
| Equals | (Overrides Object.Equals(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 Object.GetHashCode().) | ||
| 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.
|
Events| Name | Description | |
|---|---|---|
 | OnCanContinue |
This event is fired when any type of processing has finished with a page and there are more pages available. |
| OnCheck |
This event is used to allow user-written checking of recognition results. |
| OnDocumentClosed |
This event is fired if the document is closed.
|
| OnDocumentLoaded |
This event is fired if a document is loaded.
|
| OnDocumentSaved |
This event is fired if the document is saved.
|
| OnStatisticsChanged |
This event is fired whenever any modifications are done to the document.
|
| OnThumbnailsChanged |
This event is fired when the thumbnail view is changed.
|
| OnTitleChanged |
This event is fired when the document title is changed.
|
| OnZoningSettingsChanged |
This event is fired when the OCR zone settings of the document are changed.
|
RemarksTo create a new document, invoke the Documents collection's Add method. To open an existing document, invoke the Open method. To save a document for later reference, invoke the Save method. The Document object has numerous properties and settings. You can save or load all settings with the SaveSettings and LoadSettings methods. The Save method also saves all document-level settings to the document file automatically.
See Also