Sign in Join
FPDoc Onlineexperiment

THTMLBrowserHelpViewer class

In unit LazHelpHTML

Implements a browser/viewer for HTML help topics.

Declaration

pascal
THTMLBrowserHelpViewer = class(THelpViewer)

Inheritance

  1. THTMLBrowserHelpViewer
  2. THelpViewer
  3. TComponent

Description

THTMLBrowserHelpViewer is a THelpViewer descendant which extends the ancestor class to display HTML help topics in a web browser application. Properties and methods are provided to perform the following types of operations:

  • Register the viewer for use documents using the '' MIME type
  • Get the browser and command line parameters used to display HTML help topics
  • Display a node in the HTML help document
  • Load and save configuration settings for the HTML help viewer

See also

Properties

BrowserPathpublishedPath to the browser application used to view a HTML help topic.
BrowserParamspublishedParameters passed to the browser application to display a HTML help topic.
AutoRegisterpublishedIndicates if the help viewer is automatically registered in the Lazarus Help system.

Methods

CreatepublicConstructor for the class instance.
ShowNodepublicDisplays the help node for a HTML help topic.
FindDefaultBrowserpublicLocates the default browser application used for HTML help topics.
AssignpublicStores property values from the specified help browser to the current class instance.
LoadpublicLoads configuration settings for the help viewer from the specified storage.
SavepublicSave configuration settings for the help viewer to the specified storage.
GetLocalizedNamepublicGets the localized name for the HTML help browser/viewer application.

Events

OnFindDefaultBrowserpublicEvent handler signalled to find the default browser for the help viewer.

Inherited

From THelpViewer (12)

AddSupportedMimeType Destroy Hide ParameterHelp RegisterSelf SetSupportedMimeTypes ShowTableOfContents StorageName SupportedMimeTypes SupportsMimeType SupportsTableOfContents UnregisterSelf

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.