RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
ICustomHelpViewer Interface
ICustomHelpViewer Methods | ICustomHelpViewer Members | Description | See Also
Collapse All

Help Viewer access for Help System..

Class Hierarchy
Pascal
ICustomHelpViewer = interface(IInterface);
C++
__interface ICustomHelpViewer : public IInterface;
File

HelpIntfs

Description

A Help Viewer is an object which 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 this type in cross-platform applications.
 

 

See Also

RegisterViewer 

Communicating with the Help Manager 

Help System Interfaces 

Implementing ICustomHelpViewer

Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!