System.HelpIntfs.IHelpSelector.SelectKeyword
Delphi
function SelectKeyword(Keywords: TStrings) : Integer;
C++
virtual int __fastcall SelectKeyword(System::Classes::TStrings* Keywords) = 0 ;
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | IHelpSelector |
Beschreibung
Ermöglicht eine schlüsselwortbasierte Hilfeunterstützung für mehrere Viewer.
Das Hilfesystem ruft SelectKeyword auf, wenn mehrere Hilfe-Viewer Themen enthalten, die zu einer schlüsselwortbasierten Hilfeanforderung passen. Der Parameter Keywords enthält eine kombinierte Liste von Hilfestrings, die durch einen Aufruf von GetHelpStrings für jeden Viewer ermittelt wurden. SelectKeyword bezeichnet ein bestimmtes Thema, indem der Index eines bestimmten Hilfestrings zurückgegeben wird. Das Hilfesystem übergibt diesen Hilfestring dann an die Methode ShowHelp des betreffenden Viewers. Ist der Rückgabewert negativ, setzt das Hilfesystem voraus, dass die Hilfeanforderung storniert wurde, und führt keine Aktion aus.
Normalerweise zeigt SelectKeyword ein Dialogfeld an, in dem der Benutzer einen der Hilfestrings wählen kann, und gibt den Index der Benutzerauswahl zurück. Wenn der Benutzer das Dialogfeld schließt, wird ein negativer Wert zurückgegeben. Dies entspricht einem Funktionsmerkmal der meisten Viewer, hier jedoch sieht der Benutzer alle passenden Themen in einer einzigen Liste.
Anmerkung: SelectKeyword darf die Hilfestrings in der Liste nicht verändern oder neu anordnen.