System.HelpIntfs.ICustomHelpViewer.GetHelpStrings
Delphi
function GetHelpStrings(const HelpString: string): TStringList;
C++
virtual System::Classes::TStringList* __fastcall GetHelpStrings(const System::UnicodeString HelpString) = 0 ;
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | ICustomHelpViewer |
Description
Renvoie les chaînes d'aide correspondant à un mot-clé.
Le système d'aide appelle GetHelpStrings pour obtenir une liste des chaînes d'aide pour les rubriques correspondant à une requête d'aide basée sur un mot-clé. GetHelpStrings attend le mot-clé dans le paramètre HelpString et renvoie les chaînes d'aide dans un objet TStringList.
Une chaîne d'aide est une chaîne d'identification associée à une rubrique spécifique. Le système d'aide exige que chaque rubrique fournie par un visualiseur donné ait une chaîne d'aide différente. Il n'exige pas que deux visualiseurs n'utilisent jamais la même chaîne d'aide, mais une application doit éviter de le faire. Une stratégie consiste à inclure le nom du visualiseur dans la chaîne d'aide.
Le système d'aide utilise les chaînes d'aide pour fournir au sélectionneur d'aide une liste fusionnée des rubriques d'aide correspondant à la requête. Généralement, les chaînes d'aide sont constituées de descriptions lisibles des rubriques et le sélectionneur d'aide les affiche simplement pour que l'utilisateur puisse choisir la rubrique à afficher.
Pour utiliser GetHelpStrings, insérez dans la clause uses de votre application le Vcl.HtmlHelpViewer ou une autre unité fournissant une interface utilisée par le visualiseur d'aide externe. Pour C++, vous devez inclure le fichier en-tête HTMLHelpViewer.hpp.