Affichage de l'aide basée sur un mot clé
Remonter à Interfaces système d'aide
Les requêtes d'aide adressées au visualiseur d'aide sont soit basées sur un mot clé, auquel cas le visualiseur est chargé de fournir de l'aide en fonction d'une chaîne particulière, soit basées sur un contexte, auquel cas le visualiseur est chargé de fournir de l'aide en fonction d'un identificateur numérique particulier.
Remarque : Les contextes d'aide numériques sont la forme par défaut des requêtes d'aide des applications s'exécutant sous Windows et utilisant le visualiseur HTMLHelp.
Les implémentations de System.HelpIntfs.ICustomHelpViewer sont nécessaires pour prendre en charge les requêtes basées sur les mots clés, alors que les implémentations de HelpIntfs.IExtendedHelpViewer sont nécessaires pour prendre en charge les requêtes basées sur des contextes.
ICustomHelpViewer fournit trois méthodes pour traiter l'aide par mot clé :
UnderstandsKeyword(const HelpString: String): Integer
int UnderstandsKeyword(const UnicodeString HelpString)
- UnderstandsKeyword est la première des trois méthodes appelées par le gestionnaire d'aide, qui appellera chacun des visualiseurs d'aide recensés avec la même chaîne HelpString pour demander si le visualiseur peut fournir de l'aide pour cette chaîne HelpString ; UnderstandsKeyword est supposée répondre par un entier indiquant le nombre de pages d'aide différentes qu'il peut afficher en réponse à cette requête d'aide.
ICustomHelpViewer.GetHelpStrings(const HelpString: String): TStringList
Classes::TStringList*__fastcall ICustomHelpViewer::GetHelpStrings(const UnicodeString HelpString)
- GetHelpStrings est appelée par le gestionnaire d'aide si plusieurs visualiseurs peuvent fournir de l'aide mot clé HelpString particulier. Le visualiseur doit renvoyer une TStringList, qui est libérée par le gestionnaire d'aide. Les chaînes de la liste renvoyée doivent correspondre aux rubriques d'aide disponibles pour le mot clé HelpString, mais les caractéristiques de correspondance peuvent être déterminées par le visualiseur d'aide. Dans le cas du visualiseur HTMLHelp sous Windows, la liste de chaînes contient toujours une seule entrée.
ShowHelp(const HelpString: String)
void__fastcall ShowHelp(const UnicodeString HelpString)
- ShowHelp est appelée par le gestionnaire d'aide s'il a besoin que le visualiseur d'aide affiche de l'aide sur un mot clé HelpString particulier. C'est le dernier appel de méthode de l'opération ; elle n'est jamais appelée sauf si la méthode UnderstandsKeyword a été invoquée au préalable.