System.HelpIntfs.IHelpSelector.SelectKeyword
Delphi
function SelectKeyword(Keywords: TStrings) : Integer;
C++
virtual int __fastcall SelectKeyword(System::Classes::TStrings* Keywords) = 0 ;
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | IHelpSelector |
Description
Prise en charge de l'aide basée sur les mots-clé pour plusieurs visualiseurs.
Le système d'aide appelle SelectKeyword lorsque des rubriques correspondant à une requête basée sur un mot-clé sont disponibles dans plusieurs visualiseurs. Le paramètre Keywords contient une liste fusionnée de chaînes d'aide, obtenue en appelant GetHelpStrings pour chaque visualiseur. SelectKeyword indique une rubrique spécifique en renvoyant l'indice d'une chaîne d'aide spécifique. Le système d'aide passe ensuite cette chaîne d'aide à la méthode ShowHelp du visualiseur d'aide approprié. Si la valeur renvoyée est négative, le système d'aide suppose que la requête d'aide a été abandonnée et ne fait rien.
Généralement, SelectKeyword affiche une boîte de dialogue pour que l'utilisateur puisse choisir une des chaînes d'aide et renvoie l'indice du choix de l'utilisateur ou une valeur négative si l'utilisateur annule la boîte de dialogue. Cela fait doublon avec une fonctionnalité de la plupart des visualiseurs, mais permet à l'utilisateur de voir toutes les rubriques correspondantes dans une simple liste.
Remarque : SelectKeyword ne doit pas modifier ni réorganiser la liste des chaînes d'aide.