HelpContextId Property (ACommonDialog)

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

Syntax

Object.HelpContextID [ = lHelpContextId ]

The HelpContextID property syntax has the following parts:

 

Name

Type

Description

Object

ACommonDialog

ACommonDialog control

lHelpContextId

Long

An integer specifying the context ID of the requested Help topic.

Where

lHelpContextId can be one of the following:

 

Value

Description

0 *

No context number specified.

> 0

An integer specifying a valid context number.

Comments

For context-sensitive Help on an object in the application, the same context number must be assigned to both object and to the associated Help topic when the Help file is compiled.

When a user presses the F1 key, the program automatically calls Help and searches for the topic identified by the current context number.

Example

The following statement changes the ACommonDialog HelpContextID to point to item number 0x12345 in the help file and will display that topic:

cdlg1.HelpFile="MyHelp.hlp"

cdlg1.HelpCommand=acdlgHelpCommandContext

cdlg1.HelpContextId=0x12345

cdlg1.ShowHelp

Applies to

ACommonDialog

See Also

HelpCommand, HelpFile, HelpTopic, WhatsThisHelpId