System.HelpIntfs.IExtendedHelpViewer.UnderstandsTopic

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function UnderstandsTopic(const Topic: string): Boolean;

C++

virtual bool __fastcall UnderstandsTopic(const System::UnicodeString Topic) = 0 ;

Propriétés

Type Visibilité  Source Unité  Parent
function public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs IExtendedHelpViewer


Description

Demande à la visionneuse d'aide si elle comprend la chaîne Topic donnée.

UnderstandsTopic doit renvoyer True si la visionneuse d'aide peut identifier toute rubrique contenant le nom de rubrique spécifié dans le paramètre Topic.

Topic doit être unique pour toutes les rubriques gérées par une visionneuse d'aide particulière. Pour un fichier d'aide .chm, Topic doit être le nom du fichier .htm source contenant la rubrique.

Quand le système d'aide reçoit une requête d'aide basée sur une rubrique, il appelle UnderstandsTopic pour chaque visionneuse d'aide qu'il a recensée jusqu'à ce que la méthode renvoie True. Les visionneuses d'aide sont consultées dans l'ordre dans lequel elles ont été recensées dans System.HelpIntfs.RegisterViewer. Le système d'aide appelle ensuite la méthode DisplayTopic de cette visionneuse d'aide.

Pour utiliser UnderstandsTopic, insérez dans la clause uses de votre application le Vcl.HtmlHelpViewer ou toute autre unité fournissant une interface utilisée par la visionneuse d’aide externe. Pour C++, vous devez inclure le fichier d'en-tête HTMLHelpViewer.hpp.

Voir aussi