Engine Class |
Namespace: Kofax.OmniPageCSDK.IproPlus
The Engine type exposes the following members.
Name | Description | |
---|---|---|
![]() | ProcessID |
This property returns the id of the current process in which this Engine object was created. |
![]() | ProductName |
This property returns the name of the current product.
|
![]() | SerialNumber |
This property returns the serial number of the underlying engine. |
![]() | TimeOut |
This property defines the engine-wide module timeout setting. |
![]() | UILang |
Use this property to get or set the user interface language used by any displayed UI elements. |
![]() | Version |
This property returns the encoded Engine version number. |
![]() | WindowHandle |
This property is used to get or set the window handle which is used when the ENGine needs to display any UI elements. |
Name | Description | |||
---|---|---|---|---|
![]() | Dispose | Releases all resources used by the Engine | ||
![]() | GetBarcodeTypes |
This property returns the BarcodeTypes collection which enumerates the available bar code types. | ||
![]() | GetConverters |
This property returns the Converters collection, which enables enumerates the available output Converters. | ||
![]() | GetDialogFolderPath |
Use this property to get or set the default initial folders used by of the various file dialogs that are displayed when using the IPRO object model and the Visual Toolbox. | ||
![]() | GetDocumentClassifierProjects |
This API is preliminary and subject to change. | ||
![]() | GetDocuments |
The property returns the Documents collection, which contains all the documents currently maintained by the engine. | ||
![]() | GetEmptyWFInfo | This API is preliminary and subject to change. | ||
![]() | GetErrorInfo |
This property can be used to retrieve the textual representation of the specified ErrorCode. | ||
![]() | GetFormTemplateLibraries |
This API is preliminary and subject to change. | ||
![]() | GetImageFiles |
This property returns the ImageFiles collection, which enumerates the set of images loaded from physical files,
in order to apply image transformation and manipulation algorithms. | ||
![]() | GetMemoryBitmaps |
This property returns the MemoryBitmaps collection, which enumerates the set of bitmaps stored in the memory. | ||
![]() | GetModuleInfos |
This property returns the ModuleInfos collection, which contains information about the available modules in the current engine configuration. | ||
![]() | GetRecognitionLanguages |
This property returns the RecognitionLanguages collection, which enumerates the available recognition languages. | ||
![]() | GetScanners |
This property returns the Scanners collection of the engine, which enumerates all available scanners.
If the Engine is not initialized, accessing this property raises a trappable error.
| ||
![]() | 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. | ||
![]() | GetSpellLanguages |
This property returns the SpellLanguages collection, which enumerates the Spelling languages available in the current engine configuration, i.e. those
for which a Language dictionary is installed and present in the engine binary directory. | ||
![]() | GetUDManager |
This property returns the UDManager object, used to maintain user dictionaries. | ||
![]() | GetUILanguages |
This property returns the UILanguages collection, which enumerates the available Visual Toolbox User Interface languages. | ||
![]() | GetVerticalDictionaries |
This property returns the VerticalDictionaries (also called professional dictionaries) collection, which enables you to
gather information about the available vertical dictionary set. | ||
![]() | GetWFFileInfo |
This method returns the description of the specified workflow file.
| ||
![]() | Init |
This method initializes the Engine object. | ||
![]() | IsMultiPageFormat |
This helper method returns True if the image format specified by the ImgFileFormat parameter supports multi-page images (that is, a single image file can hold more than one page). | ||
![]() | Links |
This method returns the links collection.
| ||
![]() | LoadLicenseFile |
Use this method to load a license file.
| ||
![]() | LoadSettings |
This method loads the Engine, Scanner and Converter settings from a previously saved external setting file specified by the FileName parameter. | ||
![]() | SaveSettings |
This method saves the Engine, Scanner and Converter settings into an external setting file specified by the FileName parameter. | ||
![]() | SetDefaults |
This method resets the Engine default settings. | ||
![]() | SetDialogFolderPath |
Use this property to get or set the default initial folders used by of the various file dialogs that are displayed when using the IPRO object model and the Visual Toolbox. |
Name | Description | |
---|---|---|
![]() | OnHelp |
This event is fired when a Visual Control requires the integrating code to display help. |
![]() | OnModuleStateChange |
This event is fired when the engine accesses a binary module by loading it into memory. |