IHelpSystem verwenden

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Hilfesystem-Interfaces


System.HelpIntfs.IHelpSystem erfüllt drei Aufgaben für die Anwendung:

  • Sie stellt dem Hilfe-Manager Pfadinformationen bereit.
  • Sie stellt einen neuen Hilfe-Selektor bereit.
  • Sie fordert den Hilfe-Manager auf, Hilfe anzuzeigen.

Die Bereitstellung des Namens der Hilfedatei und der Pfadinformationen ist wichtig, weil der Hilfe-Manager sowohl von der Plattform als auch vom Hilfesystem unabhängig ist und somit die Position von Hilfedateien nicht voraussetzen kann. Deshalb muss eine Anwendung die Informationen der Hilfedatei über die Methoden Vcl.Forms.TApplication.HelpFile oder Vcl.Forms.TForm.HelpFile bereitstellen. Damit wird die Information der Hilfedatei über die Methode GetHelpFile von GetHelpFileIHelpManager verfügbar.

Durch die Zuweisung eines Hilfe-Selektors AssignHelpSelector kann der Hilfe-Manager Entscheidungen delegieren, wenn mehrere externe Hilfesysteme Hilfe zu einer bestimmten Kontext-ID anbieten. Nähere Informationen finden Sie unter IHelpSelector implementieren.

IHelpSystem exportiert fünf Methoden, die den Hilfe-Manager auffordern, Hilfe anzuzeigen:

Hook wird nur der Kompatibilität mit HTMLHelp halber zur Verfügung gestellt; sie erlaubt die Verarbeitung von WM_HELP-Meldungen, die nicht direkt einer Anforderung nach auf Schlüsselwörtern basierenden, kontextabhängigen oder themenbasierten Hilfe zugeordnet werden können. (Weitere Informationen finden Sie unter MSDN für Themen über HTMLHelp und WinHelp.) Die anderen Methoden verarbeiten jeweils zwei Argumente: das Schlüsselwort, die Kontext-ID oder der Name des Themas, für das bzw. welche die Hilfe angefordert wird, sowie die Hilfedatei, in der man die Hilfe vermutet.

Siehe auch