THTMLHelpDatabase class

Declaration

THTMLHelpDatabase = class(THelpDatabase)

Inheritance

1. THTMLHelpDatabase
2. THelpDatabase
3. TComponent

Description

THTMLHelpDatabase is a THelpDatabase descendant that provides support for using HTML files as context-sensitive help displayed when the F1 key is pressed in an application. THTMLHelpDatabase extends the ancestor class to include properties and methods needed to associate Help Keywords to specific HTML files, and to retrieve and display the help content.

The KeywordPrefix property is the value found at the start of a HelpKeyword which indicates that the topic belongs the HTML help database. BaseURL determines the path searched when accessing HTML files for the help database.

An application can create a THTMLHelpDatabase instance, assign the KeywordPrefix and BaseURL for the help database, and use AutoRegistered to enable the help database. Controls on the Form should use the value htKeyword in their HelpType property, and their HelpKeyword property must be set to a value that includes the KeyWordPrefix and the HTML file name accessed for the control.

THTMLBrowserHelpViewer is a companion component that allows the correct HTML help file to be displayed for the keyword/url in a web browser when the F1 key is pressed.

There is an example program that demonstrates usage of the components: examples/helphtml

See also

• THelpDatabase
• THTMLBrowserHelpViewer
• TControl.HelpKeyword
• TControl.HelpType

Properties

Methods

Inherited