System.HelpIntfs.RegisterViewer
Delphi
function RegisterViewer(const newViewer: ICustomHelpViewer; out Manager: IHelpManager): Integer;
C++
extern DELPHI_PACKAGE int __fastcall RegisterViewer(const _di_ICustomHelpViewer newViewer, /* out */ _di_IHelpManager &Manager);
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | System.HelpIntfs |
Beschreibung
Registriert die Hilfe-Viewer so, dass sie Hilfeanforderungen empfangen können.
Mit RegisterViewer registrieren Sie einen Hilfe-Viewer beim Hilfesystem. In einer Anwendung kann eine beliebige Zahl von Viewern registriert werden. Die Reihenfolge, in der Hilfe-Viewer registriert werden, ist wichtig, weil bei jeder Hilfeanforderung die Viewer in der Reihenfolge, in der sie registriert wurden, vom RTL-Hilfesystem abgefragt werden, und die Hilfeanforderung an den ersten Viewer übergeben wird, der sie bearbeiten kann. In einer Anwendung kann dieses Verhalten für schlüsselwortbasierte Hilfeanforderungen und für Anforderungen auf Anzeige des Inhaltsverzeichnisses durch Bereitstellen eines Hilfeselektorobjekts überschrieben werden.
Übergeben Sie das Hilfe-Viewer-Objekt im Parameter newViewer.
RegisterViewer gibt ein im Parameter Manager ein Hilfe-Managerobjekt zurück; der Hilfe-Viewer interagiert über dieses Objekt mit dem Hilfesystem.
Wenn der Viewer erfolgreich registriert wurde, ist der Rückgabewert von RegisterViewer True, ansonsten False.
In der VCL-Bibliothek ist die Unit Vcl.HtmlHelpViewer definiert, die ein Delphi-Interface für den externen HTMLHelp-Hilfe-Viewer enthält. HTMLHelp ist die native Hilfebehandlungsfunktion von Windows. Für die Bereitstellung des HTMLHelp-basierten Hilfe-Viewers in einer Anwendung können Sie die Unit Vcl.HtmlHelpViewer in die uses-Klausel der Anwendung einfügen. Im initialization-Abschnitt der Unit Vcl.HtmlHelpViewer wird RegisterViewer zur Registrierung des erstellten Hilfe-Viewers aufgerufen:
initialization
HelpViewer := THtmlHelpViewer.Create;
System.HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);
Folgendes wird im obigen Code ausgeführt:
- In der ersten Zeile erstellt der Konstruktor THtmlHelpViewer.Create intern das Hilfe-Viewer-Objekt
HelpViewerIntf. - In der zweiten Zeile wird die Funktion RegisterViewer aufgerufen, die diesen Hilfe-Viewer registriert.
Die globale Funktion System.HelpIntfs.GetHelpSystem kann aus anderen Units für den Zugriff auf Methoden des Hilfesystems aus dem registrierten Hilfe-Viewer aufgerufen werden.