OnWhatsThisHelp Event

Occurs when the user clicks on the object in WhatsThisHelp mode and before the WhatsThisHelp window is displayed.

Syntax

Object.OnWhatsThisHelp ( pbCancel )

The OnWhatsThisHelp event syntax has the following parts:

Name	Type	Description
Object	A control	A control object
pbCancel	Var Bool	A boolean expression that specifies whether or not a help topic will be displayed when the user selects the WhatsThisHelp icon and then selects the object.

Where

pbCancel can be one of the following:

Value	Description
True	Does not display a help topic.
False *	Displays the user-defined help topic based on the WhatsThisHelpText, or in its absence, the help associated with the WhatsThisHelpID.

Comments

Allows the user to alter the default help that is displayed at run time when the user selects the WhatsThisHelp icon from the ATEasy Help menu. When a user presses the icon and then positions the mouse icon over an item, the program automatically enters WhatsThisHelp mode and the cursor changes to . When the user clicks the mouse icon on an object, ATEasy searches for any WhatsThisHelpText for that object. If none is found, ATEasy searches for the WhatsThisHelpID for that object. If WhatsThisHelpID is set to 0, then the program looks in the WhatsThisHelpID of the object's container, and if none is found, then that object's container, and so on. If a nonzero current context number cannot be found, the request is ignored and nothing is displayed.

Example

chkAlphaTest.OnWhatsThisHelp(pbCancel)

{

if chkAlphaTest.Enabled=FALSE

bCancel=FALSE

endif

if pbCancel=FALSE

chkAlphaTest.WhatsThisHelpID=56

! Set Help topic to 56