Vcl.HtmlHelpViewer.IHtmlHelpTester

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

IHtmlHelpTester = interface(IInterface)

C++

__interface  INTERFACE_UUID("{82DF78E6-B675-4F5D-8A5B-F9BEEDDC14F6}") IHtmlHelpTester  : public System::IInterface

Properties

Type Visibility Source Unit Parent
interface
class
public
Vcl.HtmlHelpViewer.pas
Vcl.HtmlHelpViewer.hpp
Vcl.HtmlHelpViewer Vcl.HtmlHelpViewer


Description

Methods of this interface help to maintain and analyze help files and lists of keywords, ALinks, context IDs, and help topics, which can be used in requests to the Windows HTMLHelp help API function.

VCL does not provide an implementation of this interface. If you need to support its functionality, you must implement IHtmlHelpTester in your application.

Because the Microsoft HtmlHelp function does not support direct querying without displaying results, it is necessary for the Help Viewer to maintain and analyze by itself lists of keywords, ALinks, context IDs, and help topics, which can be used in requests to HTMLHelp. Applications wanting to support this functionality must implement IHtmlHelpTester themselves. If an an implementation of IHtmlHelpTester is absent, the HTMLHelp viewer will always assume that the query should succeed and HTMLHelp can be asked to provide help.

See Also