TApplication.HelpShowTableOfContents function
Displays the Help Table of Contents using the Help Manager for the application.
Declaration
function HelpShowTableOfContents: BooleanFunction result
True if the Help Table of Contents was successfully displayed by the application.Description
HelpShowTableOfContents is a method used to display the Help Table
of Contents for the application. It uses the global
HelpManager
variable (when assigned) to call its
ShowTableOfContents method.
This method must be re-implemented in a descendent class; the default
implementation simply returns the
shrHelpNotFound result.
The return value is True when the HelpManager successfully displays
the Table of Contents, and returns the shrSuccess result code. If
HelpManager has not been assigned, the return value is always False.
Added in LCL version 2.2.0. This method is Delphi compatible.
See also
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.