Sign in Join
FPDoc Onlineexperiment

TControl.ShowHelp procedure

Member of TControlpublicIn unit Controls

Displays the help associated with the control.

Declaration

pascal
procedure ShowHelp; virtual

Description

ShowHelp is a method used to display help for the control. Values in HelpType, HelpContext, and HelpKeyword are used to determine which method is called in the Application singleton to display the help content.

HelpType
When set to htContext, the HelpContext method is called for the value in the HelpContext property.
HelpKeyword
A non-empty value causes the HelpKeyword method to be called using the value in the HelpKeyword property.
Default Action
Calls the ShowHelp method in the Parent control when none of the other conditions are satisfied.

ShowHelp is called from methods in the TApplication instance. It occurs when the F1 key is pressed when the control has focus, or when its ShowHelpForObject method is called for a specific control instance.

Use the HelpFile property, found on the parent form or in a TApplicationProperties instance, to set the help file with the content displayed in the method.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.