WhatsThisHelpText Property

Returns or sets the text used for WhatsThisHelp for invoking help on the the object in WhatsThisHelp mode.

Syntax

Object.WhatsThisHelpText [ = sWhatsThisHelpText ]

The WhatsThisHelpText property syntax has the following parts:

 

Name

Type

Description

Object

Object

An object

sWhatsThisHelpText

BString

A string specifying the text to be used for WhatsThisHelp.

Comments

When a user presses the Help Icon on the form caption 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.

The WhatsThisHelpText field is designed to be short, that is, only a few lines long.

Example

The following statement changes the AButton's WhatsThisHelpText to the text shown:

btn1.WhatsThisHelpText="A Button control for allowing a binary choice to the user."

Applies to

All controls and the following classes:

 

AForm

AMenu

See Also

Help, HelpContextID, HelpFile, MsgBox, OnHelpContext, OnWhatsThisHelp, ShowHelpContext, ShowWhatsThis, ToolTipText, WhatsThisButton, WhatsThisHelpID, WhatsThisMode