Implémentation de IHelpSelector

De RAD Studio
Aller à : navigation, rechercher

Remonter à Interfaces système d'aide


Avertissement ! RAD Studio ne fournit pas une implémentation de l'interface IHelpSelector. Pour utiliser les méthodes de cette interface, vous devez fournir votre propre implémentation.

System.HelpIntfs.IHelpSelector est un compagnon de System.HelpIntfs.ICustomHelpViewer. Lorsque plusieurs visualiseurs recensés peuvent assurer le support du mot clé, du contexte ou de la rubrique spécifié, ou peuvent fournir un sommaire, le gestionnaire d'aide doit faire un choix entre eux. Dans le cas des contextes ou des rubriques, le gestionnaire d'aide sélectionne toujours le premier visualiseur d'aide prétendant assurer le support. Dans le cas des mots clés ou des sommaires, le gestionnaire d'aide, par défaut, sélectionne le premier visualiseur d'aide. Ce comportement peut être redéfini par une application.

Pour supplanter la décision du gestionnaire d'aide, une application doit recenser une classe fournissant une implémentation de l'interface IHelpSelector. IHelpSelector exporte deux fonctions : SelectKeyword et TableOfContents. Les deux acceptent comme argument un TStrings contenant, l'un à la suite de l'autre, soit les correspondances possibles des mots clés, soit les noms des visualiseurs pouvant fournir un sommaire. L'implémenteur est nécessaire pour renvoyer l'indice (dans le TStringList) représentant la chaîne sélectionnée, puis le TStringList est libéré par le gestionnaire d'aide.

Remarque :  Le gestionnaire d'aide risque de se tromper si les chaînes sont réarrangées ; il est conseillé que les implémenteurs de IHelpSelector ne le fassent pas. Le système d'aide ne supporte qu'un seul HelpSelector ; lorsque de nouveaux sélecteurs sont recensés, tout sélecteur existant préalablement est déconnecté.

Voir aussi