System.HelpIntfs.IHelpSystem3.ShowSearch

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

procedure ShowSearch(const Topic, HelpFileName: string);

C++

virtual void __fastcall ShowSearch(const System::UnicodeString Topic, const System::UnicodeString HelpFileName) = 0 ;

Eigenschaften

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

Beschreibung

Öffnet das Suchfenster des Hilfe-Viewers.

Das RTL-Hilfesystem ruft ShowSearch auf, um ein Viewer sein Suchenfenster zu öffnen. Wenn der Hilfe-Viewer nach dem angegebenen Themenparameter suchen kann, führt er die Suche aus; ansonsten wird sie ignoriert. Der HelpFileName-Parameter wird nur in bestimmten Hilfesystemen (wie z.B Microsoft HTML-Hilfe) verwendet und nur wenn kein von dem Hilfesystem bekannter Hilfedateiname vorhanden ist.

Die Hilfesystem fragt alle registrierten Hilfe-Viewers ab. Wenn nur ein Viewer ein Suchenfenster anzeigen kann, dann wird es angezeigt; ansonsten muss der Benutzer sich entscheiden, welcher Viewer angezeigt werden soll.

Siehe auch