IControl.HelpContext

Syntax

HelpContext: Integer;

Description

The HelpContext property determines a unique index for a section of a context help for this component.

Comments

When creating help system files, each page can be assigned with a unique identifier. It is assigned on creating a map ID. When creating a map ID, each identifier is also assigned with a unique index. This index should be specified in the HelpContext property to map the component with the specific help system page. For details about creating a map ID see the guide for the specific software used for creating a help system file.

A help system page with the section corresponding to the specified index will be shown to the user if the component is focused, and the F1 button is pressed or the ? hint button is pressed, after which the component is clicked. The hint button becomes available after the BorderStyle property is set to DialogWithHelp. This button click can be simulated by means of the EnterContextHelpMode method.

If HelpContext = 0, the component inherits HelpContext of the parent (the component, on which it is located, or the form). For example, if the HelpContext value is set for the form, the help section that corresponds to the unique index specified for the form, is shown for all components for which HelpContext=0.

Read the additional description in the Questions and Answers: Using Custom Help section.