This event is fired when a Visual Control requires the integrating code to display help.
Namespace:
Kofax.OmniPageCSDK.IproPlusAssembly:
Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntaxpublic event EngineHelpHandler OnHelp
Public Event OnHelp As EngineHelpHandler
public:
event EngineHelpHandler^ OnHelp {
void add (EngineHelpHandler^ value);
void remove (EngineHelpHandler^ value);
}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.
See Also