Click or drag to resize

Engine Class

Returns the Engine object.
Inheritance Hierarchy

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

The Engine type exposes the following members.

Constructors
  NameDescription
Public methodEngine
Initializes a new instance of the Engine class
Top
Properties
  NameDescription
Public propertyProcessID
This property returns the id of the current process in which this Engine object was created.
Public propertyProductName
This property returns the name of the current product.
Public propertySerialNumber
This property returns the serial number of the underlying engine.
Public propertyTimeOut
This property defines the engine-wide module timeout setting.
Public propertyUILang
Use this property to get or set the user interface language used by any displayed UI elements.
Public propertyVersion
This property returns the encoded Engine version number.
Public propertyWindowHandle
This property is used to get or set the window handle which is used when the ENGine needs to display any UI elements.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the Engine
Public methodGetBarcodeTypes
This property returns the BarcodeTypes collection which enumerates the available bar code types.
Public methodGetConverters
This property returns the Converters collection, which enables enumerates the available output Converters.
Public methodGetDialogFolderPath
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.
Public methodGetDocumentClassifierProjects
Caution note Caution
This API is preliminary and subject to change.
Public methodGetDocuments
The property returns the Documents collection, which contains all the documents currently maintained by the engine.
Public methodGetEmptyWFInfo
This API is preliminary and subject to change.
Public methodGetErrorInfo
This property can be used to retrieve the textual representation of the specified ErrorCode.
Public methodGetFormTemplateLibraries
Caution note Caution
This API is preliminary and subject to change.
Public methodGetImageFiles
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.
Public methodGetMemoryBitmaps
This property returns the MemoryBitmaps collection, which enumerates the set of bitmaps stored in the memory.
Public methodGetModuleInfos
This property returns the ModuleInfos collection, which contains information about the available modules in the current engine configuration.
Public methodGetRecognitionLanguages
This property returns the RecognitionLanguages collection, which enumerates the available recognition languages.
Public methodGetScanners
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.
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 methodGetSpellLanguages
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.
Public methodGetUDManager
This property returns the UDManager object, used to maintain user dictionaries.
Public methodGetUILanguages
This property returns the UILanguages collection, which enumerates the available Visual Toolbox User Interface languages.
Public methodGetVerticalDictionaries
This property returns the VerticalDictionaries (also called professional dictionaries) collection, which enables you to gather information about the available vertical dictionary set.
Public methodGetWFFileInfo
This method returns the description of the specified workflow file.
Public methodInit
This method initializes the Engine object.
Public methodIsMultiPageFormat
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).
Public methodLinks
This method returns the links collection.
Public methodLoadLicenseFile
Use this method to load a license file.
Public methodLoadSettings
This method loads the Engine, Scanner and Converter settings from a previously saved external setting file specified by the FileName parameter.
Public methodSaveSettings
This method saves the Engine, Scanner and Converter settings into an external setting file specified by the FileName parameter.
Public methodSetDefaults
This method resets the Engine default settings.
Public methodSetDialogFolderPath
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.
Top
Events
  NameDescription
Public eventOnHelp
This event is fired when a Visual Control requires the integrating code to display help.
Public eventOnModuleStateChange
This event is fired when the engine accesses a binary module by loading it into memory.
Top
See Also