System.HelpIntfs.ICustomHelpViewer

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

ICustomHelpViewer = interface(IInterface)

C++

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

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
interface
class
public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs System.HelpIntfs

Beschreibung

Hilfe-Viewer, der den Zugriff auf das Hilfesystem ermöglicht. Mit den Methoden der Hilfe-Viewers können ein Inhaltsverzeichnis und durch Schlüsselwörter festgelegte Hilfethemen angezeigt werden.

Ein Hilfe-Viewer ist ein Objekt, das im Auftrag der Anwendung die vom Hilfesystem erhaltenen Hilfeanforderungen bearbeitet. Ein Hilfe-Viewer ist typischerweise eine Kapselung für eine externe Anwendung wie eine Hilfe-Engine oder einen Web-Browser.

Die Hilfe-Viewer-Klasse muss das Interface ICustomHelpViewer oder eines der davon abgeleiteten Interfaces, IExtendedHelpViewer oder ISpecialWinHelpViewer, implementieren. Das Hilfesystem nutzt Methoden aus diesen Interfaces zur Übergabe der Hilfeanforderungen an den Hilfe-Viewer.

Zur Verwendung eines Hilfe-Viewers muss eine Anwendung die globale Funktion RegisterViewer aufrufen.

Hinweis: ISpecialWinHelpViewer steht nur in den Windows-Produkten zur Verfügung. Verwenden Sie diesen Hilfe-Viewer nicht in plattformübergreifenden Anwendungen.

Siehe auch