Vcl.Forms.TApplication.HelpShowTableOfContents

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function HelpShowTableOfContents: Boolean;

C++

bool __fastcall HelpShowTableOfContents();

Properties

Type Visibility Source Unit Parent
function public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication

Description

Shows the table of contents within the Help system.

Use HelpShowTableOfContents to bring up the table of contents for the Help system specified in the CurrentHelpFile property. This method is preferred to calling System.HelpIntfs.ICustomHelpViewer.ShowTableOfContents, which cannot be used as the first call into the help system.

In order for HelpShowTableOfContents to work and to call the proper native Help handling function, insert in the uses clause of your application the Vcl.HtmlHelpViewer or another unit that provides an interface to the external Help viewer to use. The Vcl.HtmlHelpViewer unit provides a Delphi interface to the HTMLHelp Windows native Help handling function. For C++, you need to include the HTMLHelpViewer.hpp header files.

For information about the native Help handling functions (HTMLHelp or other) and about the data passed to them, see the appropriate HTMLHelp topics in the MSDN Library.

See Also