System.HelpIntfs.ICustomHelpViewer

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

ICustomHelpViewer = interface(IInterface)

C++

__interface  INTERFACE_UUID("{B0FC9364-5F0E-11D3-A3B9-00C04F79AD3A}") ICustomHelpViewer  : public System::IInterface

Properties

Type Visibility Source Unit Parent
interface
class
public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs System.HelpIntfs

Description

Help Viewer that provides access to the Help System. Its methods display a table of contents and Help topics specified by keywords.

A Help Viewer is an object that handles application Help requests passed to it by the Help System on behalf of an application. A Help Viewer is typically a wrapper for an external application, such as a Help engine or web browser.

The Help Viewer class must implement the ICustomHelpViewer interface, or one of its descendant interfaces, IExtendedHelpViewer and ISpecialWinHelpViewer. The Help System uses methods from these interfaces to pass Help requests to the Help Viewer.

To use a Help Viewer, an application must call the global RegisterViewer function.

Note: ISpecialWinHelpViewer is only provided with Windows products. Do not use it in cross-platform applications.

See Also