Click or drag to resize

EngineOnHelp Event

This event is fired when a Visual Control requires the integrating code to display help.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public event EngineHelpHandler OnHelp

Value

Type: Kofax.OmniPageCSDK.IproPlusEngineHelpHandler
Remarks

This happens, for example, if there is an open dialog, such as the TEC Proofing Dialog and the user presses the F1 key. The HelpCaller parameter identifies the control raising the request. The HandleCaller is the HWND of the caller. The HelpType denotes whether a help topic or a context help request happened. The HelpItem parameter, depending on the HelpType parameter, is either a value of the HELPTOPIC or the HELPCONTEXT enumeration identifying the information piece requested. You can see the possible values of the related enumerated types in the lists under the relevant topics.

Parameter Type Enumeration
HELPCALLER HELPCALLER Enumeration
HELPTYPE HELPTYPE Enumeration
HELPTOPIC HELPTOPIC Enumeration
HELPCONTEXT HELPCONTEXT Enumeration
See Also