THelpDatabase class

In unit LazHelpIntf

Provides support for integrating a collection of related help topics with a table of contents.

Declaration

pascal

THelpDatabase = class(TComponent)

Inheritance

THelpDatabase
TComponent

Descends from it: THTMLHelpDatabase

Description

Nothing more than the line above yet.

Properties

`Databases`	public	Help databases registered for use with the LCL help manager.
`ID`	public	Unique identifier for the hep database.
`SupportedMimeTypes`	public	Contains the list of MIME types supported in the help database.
`BasePathObject`	public	Represents the base path for the help database.
`TOCNode`	public	Help node with the Table of Contents for the help database.
`AutoRegister`	public	Indicates if the help database is automatically registered at run-time.

Methods

`SetSupportedMimeTypes`	protected	Sets the value in the SupportedMimeTypes property.
`AddSupportedMimeType`	protected	Adds a MIME type entry to the list in SupportedMimeTypes.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`Reference`	public	Increments the number of references for the class instance.
`RegisterSelf`	public	Ensures that the LCL Help system has been initialized.
`Release`	public	Decrements the internal reference count for the help database`
`UnregisterSelf`	public
`Registered`	public	Indicates if the list of help databases has been initialized for the database instance.
`CanShowTableOfContents`	public	Determines if a Table of Contents node is available for the help database.
`ShowTableOfContents`	public	Displays the Table of Contents in the TOCNode for the help database.
`ShowError`	public	Displays an error message using the help manager, or raises an exception.
`ShowHelp`	public
`ShowHelpFile`	public	Displays a help topic with the specified file name.
`SupportsMimeType`	public	Determines is the specified MIME type is supported in the help database.
`GetNodesForKeyword`	public	Creates or updates a list of help nodes using the specified help HelpKeyword.
`GetNodesForDirective`	public
`GetNodesForContext`	public	Creates or updates the list of help nodes for the specified help context.
`GetNodesForPascalContexts`	public	Creates or updates a list of nodes for the specified Pascal help GetNodesForPascalContexts.
`GetNodesForClass`	public	Creates or updates a list of help nodes for the specified class.
`GetNodesForMessage`	public	Creates or updates a list of help nodes matching the specified message.
`FindViewer`	public	Gets the help viewer which supports the specified MIME type.
`RegisterItem`	public	Adds the specified item to the search items for the help database.
`RegisterItemWithNode`	public	Adds a search item to the help database for the specified help node.
`RegisterFileItemWithNode`	public	Adds a search item to the help database for the source file with the specified file name.
`UnregisterItem`	public	Removes the specified item from the search items for the help database.
`UnregisterAllItems`	public
`RegisteredItemCount`	public
`GetRegisteredItem`	public	Gets the number of registered search items for the help database.
`Load`	public
`Save`	public
`GetLocalizedName`	public	Gets the localized name (ID) for the help database.

Events

OnFindViewer public Event handler signalled to locate the viewer for the help database.

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