System.HelpIntfs.ICustomHelpViewer.GetHelpStrings
Delphi
function GetHelpStrings(const HelpString: string): TStringList;
C++
virtual System::Classes::TStringList* __fastcall GetHelpStrings(const System::UnicodeString HelpString) = 0 ;
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | ICustomHelpViewer |
Beschreibung
Gibt die Hilfe-Strings zurück, die mit einem bestimmten Schlüsselwort übereinstimmen.
Das Hilfesystem ruft GetHelpStrings auf, um eine Liste mit Hilfe-Strings für Themen zusammenzustellen, die zu einer schlüsselwortbasierten Hilfeanforderung passen. GetHelpStrings erwartet das Schlüsselwort im Parameter HelpString und gibt die Hilfe-Strings in einem TStringList-Objekt zurück.
Ein Hilfe-String identifiziert ein bestimmtes Thema. Das Hilfesystem erfordert, dass alle von einem bestimmten Viewer bereitgestellten Themen einen unterschiedlichen Hilfe-String haben. Das Hilfesystem lässt zwar zu, dass ein und derselbe Hilfe-String in zwei verschiedenen Viewern verwendet wird, dies sollte aber von der Anwendung vermieden werden. Eine mögliche Strategie besteht darin, den Viewer-Namen in den Hilfestring zu integrieren.
Das Hilfesystem verwendet Hilfe-Strings, um dem Hilfeselektor eine zusammengefasste Liste von Hilfethemen zu übergeben, die zu einer Anforderung passen. Normalerweise handelt es sich dabei um Themenbeschreibungen in natürlicher Sprache, aus denen der Benutzer das zur Anzeige gewünschte Thema auswählen kann.
Für die Verwendung von GetHelpStrings fügen Sie der uses-Klausel Ihrer Anwendung die Unit Vcl.HtmlHelpViewer oder eine andere Unit hinzu, die ein Interface für den externen, zu verwendenden Hilfe-Viewer bereitstellt. Bei C++ müssen Sie die Header-Datei HTMLHelpViewer.hpp einbeziehen.