RAD Studio |  |

Displaying Tables of Contents
See Also
Collapse All

ICustomHelpViewer provides two methods relating to displaying tables of contents:

- CanShowTableOfContents
- ShowTableOfContents

The theory behind their operation is similar to the operation of the keyword Help request functions: the Help Manager first queries all Help viewers by calling ICustomHelpViewer.CanShowTableOfContents : Boolean and then invokes a particular Help viewer by calling ICustomHelpViewer.ShowTableOfContents.

It is reasonable for a particular viewer to refuse to allow requests to support a table of contents. The Man page viewer does this, for example, because the concept of a table of contents does not map well to the way Man pages work; the HyperHelp viewer supports a table of contents, on the other hand, by passing the request to display a table of contents directly to WinHelp on Windows and HyperHelp on Linux. It is not reasonable, however, for an implementation of ICustomHelpViewer to respond to queries through CanShowTableOfContents with the answer True, and then ignore requests through ShowTableOfContents.

See Also

Enabling Help in Applications

Help System Interfaces

Communicating with the Help Manager

Implementing ICustomHelpViewer

Asking the Help Manager for Information

Displaying Tables of Contents

Implementing IExtendedHelpViewer

Implementing IHelpSelector

Registering Help System Objects

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!