System.HelpIntfs.IExtendedHelpViewer.DisplayHelpByContext

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

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

C++

virtual void __fastcall DisplayHelpByContext(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 IExtendedHelpViewer

Description

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

Le système d'aide appelle DisplayHelpByContext pour gérer une requête d'aide basée sur le contexte :

  • ContextID représente l'identificateur de contexte numérique de la rubrique. Pour un fichier d'aide .chm, vous devez mapper symboliquement les IDs de contexte des rubriques d'aide aux valeurs numériques des IDs de rubrique dans la section [MAP] de votre fichier projet (.hhp).
  • HelpFileName correspond au nom du fichier contenant la rubrique. Sachez toutefois que certains moteurs d'aide exigent le nom complet du fichier.

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

Voir aussi