System.HelpIntfs.ICustomHelpViewer.CanShowTableOfContents

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function  CanShowTableOfContents : Boolean;

C++

virtual bool __fastcall CanShowTableOfContents() = 0 ;

Properties

Type Visibility Source Unit Parent
function public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs ICustomHelpViewer

Description

Query support for the Table of Contents.

The Help System uses CanShowTableOfContents to determine which Help Viewers can display a Table of Contents. CanShowTableOfContents should return True if the Viewer is ready for a subsequent call to ShowTableOfContents. The Help System should not call ShowTableOfContents for a Viewer after CanShowTableOfContents returns False; if this occurs, the Viewer should raise an EHelpSystemException.

In order to use CanShowTableOfContents, 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. For C++, you need to include the HTMLHelpViewer.hpp header file.

See Also