InteractionEvents.OnHelp Event

Parent Object: InteractionEvents

Description

Event that fires to signal the client to present help for the associated activity.

Syntax

InteractionEvents.OnHelp( BeforeOrAfter As EventTimingEnum, Context As NameValueMap, HandlingCode As HandlingCodeEnum )

Parameters

Name Type Description
BeforeOrAfter EventTimingEnum Input indicating if the event is being fired before (kBefore) or after (kAfter) the assembly structure is changed.
Context NameValueMap Input NameValueMap object that can be used to determine the context of why the event fired. In this case it specifies whether the user pressed the F1 key or selected "How to..." from the context menu. A value of "Help" maps to the F1 key, and "HowTo" to the context menu.
HandlingCode HandlingCodeEnum Output that indicates how you are handling the event. The value of this argument is currently ignored for this event.

Version

Introduced in version 7