Vcl.Forms.TApplication.HelpJump
Delphi
function HelpJump(const JumpID: string): Boolean;
C++
bool __fastcall HelpJump(const System::UnicodeString JumpID);
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
Description
Affiche la rubrique d'aide spécifiée par le nom symbolique.
Appelez HelpJump pour afficher une rubrique identifiée par son nom symbolique JumpID à partir du fichier d'aide spécifié par la propriété CurrentHelpFile.
HelpJump génère un événement OnHelp soit sur la fiche active, soit sur l'objet application lui-même. S'il n'existe pas de gestionnaire d'événements OnHelp ou si le gestionnaire d'événements indique qu'une fonction de gestion d'aide native doit être appelée, HelpJump appelle alors la fonction de gestion d'aide native HTMLHelp (ou WinHelp), en lui transmettant le nom symbolique JumpID. Pour un fichier d'aide .chm, JumpID doit être le nom du fichier .htm source contenant la rubrique.
HelpJump renvoie False si CurrentHelpFile est une chaîne vide, ce qui signifie que l'application n'a pas de fichier d'aide affecté. Dans tous les autres cas, HelpJump renvoie True.
Pour que HelpJump fonctionne et qu'elle appelle la fonction de gestion d'aide native appropriée, 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. L'unité Vcl.HtmlHelpViewer fournit une interface Delphi à la fonction de gestion d'aide native Windows HTMLHelp. Pour C++, vous devez inclure les fichiers d'en-tête HTMLHelpViewer.hpp.
Pour obtenir des informations sur les fonctions de gestion d'aide natives (HTMLHelp ou autre) et sur les données qui leur sont transmises, voir les rubriques HTMLHelp appropriées dans la bibliothèque MSDN.