System.HelpIntfs.IHelpSystem.ShowHelp

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

procedure ShowHelp(const HelpKeyword, HelpFileName: string);

C++

virtual void __fastcall ShowHelp(const System::UnicodeString HelpKeyword, const System::UnicodeString HelpFileName) = 0 ;

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
procedure
function
public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs IHelpSystem

Beschreibung

Dient zur Ausführung einer schlüsselwortbasierten Hilfeanforderung.

Mit ShowHelp wird eine schlüsselwortbasierte Hilfeanforderung übergeben. Standardmäßig übergibt das RTL-Hilfesystem die Anforderung an den ersten Hilfe-Viewer, der signalisiert, diese bearbeiten zu können. Typischerweise übergibt der Viewer die Hilfeanforderung an eine externe Hilfe-Engine, die eine Liste passender Themen anzeigt (falls mehrere vorhanden sind) oder direkt ein bestimmtes Thema öffnet (wenn nur ein Thema passt).

Um schlüsselwortbasierte Hilfeanforderungen bei Verwendung mehrerer Viewer zu ermöglichen, weisen Sie mit der Methode AssignHelpSelector einen Hilfeselektor zu.