WhatsThisHelpID Property (ACommonDialog)

Returns or sets the WhatsThisHelp ID of the requested Help topic.

Syntax

Object.WhatsThisHelpID [ = lWhatsThisHelpID ]

The WhatsThisHelpID property syntax has the following parts:

Name	Type	Description
Object	ACommonDialog	ACommonDialog control
lWhatsThisHelpID	Long	An integer specifying the WhatsThisHelp ID of the requested Help topic.

Where

lWhatsThisHelpID can be one of the following:

Value	Description
0 *	No context number specified.
> 0	An integer specifying a valid context number.

Comments

The WhatsThisHelpID is an integer specifying the position in the help file (context number) for relevant help text for this object. This is used to provide context-sensitive Help for the application following the user selecting the Help Icon (question mark on the toolbar).

The current context number is the value of WhatsThisHelpID for the object that has the focus.

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.

Example

The following statement changes the WhatsThisHelpID to point to item number 56 in the help file and displays that topic:

cdlg1.HelpFile="MyHelp.hlp"

cdlg1.HelpCommand=acdlgHelpCommandWhatsThis

cdlg1.WhatsThisHelpID=56

cdlg1.ShowHelp

Applies to

ACommonDialog