System.HelpIntfs.IHelpSystem.ShowContextHelp

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

procedure ShowContextHelp(const ContextID: THelpContext; const HelpFileName: string);

C++

virtual void __fastcall ShowContextHelp(const System::Classes::THelpContext ContextID, const System::UnicodeString HelpFileName) = 0 ;

Propriétés

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


Description

Affiche la rubrique d'aide spécifiée par l'identificateur de contexte numérique ContextID.

Appelez ShowContextHelp pour afficher une rubrique d'aide identifiée par l'identificateur de contexte numérique ContextID et qui se trouve dans le fichier d'aide HelpFileName spécifié.

Pour un fichier d'aide .chm, vous devez mapper symboliquement les IDs de contexte des rubriques d'aide aux valeurs numériques du ContextID dans la section [MAP] de votre fichier projet (.hhp).

Pour que les requêtes d'aide basées sur le contexte fonctionnent, l'application doit avoir préalablement recensé au moins une visionneuse d'aide qui implémente IExtendedHelpViewer. Si une telle visionneuse n'est pas trouvée, une exception EHelpSystemException est déclenchée.

Pour utiliser ShowContextHelp, 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.