Click or drag to resize

EngineWindowHandle Property

This property is used to get or set the window handle which is used when the ENGine needs to display any UI elements.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public IntPtr WindowHandle { get; set; }

Property Value

Type: IntPtr
Remarks

It is not often that the Engine will show any UI items when an application uses the IPRO libraries, but there are some exceptions such as when the ScannerWizard adds and configures the system's scanners. Setting this property to the value of the integrating application's main window is recommended to prevent UI elements from appearing behind the application window. If IPRO objects are used in .NET environments, a control handle must be converted to an integer.

This property can be overridden with the Document object's WindowHandle property. It is also overridden if the hWnd parameter is specified when calling the ScannerWizard method of the Scanners collection object. The default value for this property is 0, which means that any displayed UI elements will not have a parent window.

See Also