Vcl.HtmlHelpViewer

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Implementiert den Wrapper für die Windows-HTMLHelp-Funktions-API.

Package vcl280.bpl

Klassen

IHtmlHelpTesterMethoden dieses Interface unterstützen die Verwaltung und Analyse von Hilfedateien und Schlüsselwortlisten, ALinks, Kontext-IDs und Hilfethemen, die in Anforderungen der Windows-API-Hilfefunktion HTMLHelp verwendet werden können.

Variablen

HtmlHelpTesterIn der Variable HtmlHelpTester wird das erstellte Objekt vom Typ IHtmlHelpTester gespeichert.
ViewerNameIn der Variable ViewerName wird ein String gespeichert, mit dem der Hilfemanager diesen Viewer unter anderen registrierten Viewern identifizieren kann.

Beschreibung

Die Unit HtmlHelpViewer implementiert einen externen Hilfe-Viewer, der den Wrapper für die Windows-HTMLHelp-Funktions-API bereitstellt. Das Designziel für diese Unit ist für den VCL-Hilfe-Manager nicht von anderen externen Hilfe-Viewern unterscheidbar. Dementsprechend werden nur die Funktionen der HTMLHelp-API gekapselt, die vom in der Unit System.HelpIntfs implementierten Hilfesystem verwendet werden.

HtmlHelpViewer kapselt die HTMLHelp-API-Funktionen in der THtmlHelpViewer-Klasse, die im Abschnitt implementation als "private" deklariert wird. Die Klasse THtmlHelpViewer implementiert Hilfe-Interfaces, die in der Unit System.HelpIntfs deklariert sind. System.HelpIntfs stellt die Interfaces bereit, über die das Hilfesystem Hilfeanforderungen zwischen Anwendungen und einem externen Hilfe-Viewer, wie HTMLHelp, weitergeben kann.

Um auf Methoden der als private deklarierten THtmlHelpViewer-Klasse aus anderen Units zuzugreifen, wird im Abschnitt initialization dieser Unit das HelpViewer-Objekt dieser Klasse erstellt und die globale Funktion System.HelpIntfs.RegisterViewer zum Registrieren des Hilfe-Managers aufgerufen. Mit der globalen Funktion System.HelpIntfs.GetHelpSystem aus der Unit System.HelpIntfs können Hilfesystemobjekte des registrierten HelpViewer abgerufen werden. Mit Code aus anderen Units kann dann auf Methoden der abgerufenen Hilfesystemobjekte zugegriffen werden.

Beziehen Sie die Unit HTMLHelp in den uses-Abschnitt der Unit "main" (oder in eine andere geeignete Unit) Ihrer Anwendung ein, um den HtmlHelpViewer-Hilfe-Viewer in Ihrer Anwendung zu verwenden.

initialization-Abschnitt

Der initialization-Abschnitt der Unit HtmlHelpViewer enthält die folgende Initialisierung:

 HelpViewer := THtmlHelpViewer.Create;
 HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);

Folgendes wird im obigen Code ausgeführt:

  • Durch den Konstruktor THtmlHelpViewer.Create in der ersten Zeile wird das Hilfe-Viewer-Objekt HelpViewerIntf der Klasse THtmlHelpViewer intern erstellt und in der Variable HelpViewer gespeichert.
  • In der zweiten Zeile wird die globale Funktion System.HelpIntfs.RegisterViewer zum Registrieren des erstellen Hilfe-Viewers aufgerufen.

Die globale Funktion System.HelpIntfs.GetHelpSystem kann in anderen Units für den Zugriff auf Methoden des Hilfesystems aus dem registrierten Hilfe-Viewer aufgerufen werden.

Siehe auch