HelpContext property

Project: Message Dialogue Components.

Unit: PJMessageDialog.

Class: TPJVCLMsgDlg

Applies to: ~>3.0

type
  THelpContext = -MaxLongInt..MaxLongInt;

property HelpContext: THelpContext;

Description

Set the HelpContext property to the context number of the relevant topic in the help file specified by the HelpFile property. This topic is displayed when the user presses F1 in the dialogue box or clicks any help button that is displayed.

There are two ways the dialogue can display a help button that accesses the help topic:

  1. By including mbHelp in the Buttons property and clearing the mdoAutoHelpBtn value of the Options property.
  2. By setting the mdoAutoHelpBtn value of the Options property and giving HelpContext a non-zero value.

If OnHelp is not handled and a help button is pressed, a request is made to the Application object to pass the help context along to the currently registered help system.