System.HelpIntfs.IExtendedHelpViewer.UnderstandsContext
Delphi
function UnderstandsContext(const ContextID: THelpContext;
const HelpFileName: string): Boolean;
C++
virtual bool __fastcall UnderstandsContext(const System::Classes::THelpContext ContextID, const System::UnicodeString HelpFileName) = 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 le ContextID
numérique donné.
UnderstandsContext doit renvoyer True si la visionneuse d'aide peut afficher la rubrique identifiée par l'identificateur de contexte numérique ContextID
dans le fichier d'aide HelpFileName
spécifié.
Quand le système d'aide reçoit une requête d'aide basée sur un ID de contexte, il appelle UnderstandsContext 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 DisplayHelpByContext de cette visionneuse d'aide.
Pour utiliser UnderstandsContext, insérez dans la clause uses de votre application le Vcl.HtmlHelpViewer ou une 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.