Vcl.Forms.TApplication.HelpFile

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

property HelpFile: string read FHelpFile write FHelpFile;

C++

__property System::UnicodeString HelpFile = {read=FHelpFile, write=FHelpFile};

Propriétés

Type Visibilité  Source Unité  Parent
property public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication

Description

Spécifie le nom du fichier par défaut que l'application utilise pour afficher l'aide.

Utilisez la propriété HelpFile pour spécifier le fichier d'aide par défaut pour les applications qui utilisent le système d'aide VCL.

Vous pouvez affecter par programme un nom de fichier d'aide à la propriété HelpFile du type d'objet TApplication à l'exécution ou spécifier un nom de fichier d'aide pour l'option Fichier d'aide dans la page Options de l'application de la boîte de dialogue Options de projet à l'exécution.

Le système d'aide spécifié par Vcl.Forms.TApplication.HelpSystem affiche les rubriques d'aide à partir du fichier spécifié par CurrentHelpFile. HelpFile fournit la valeur de CurrentHelpFile à moins qu'il n'existe un fichier d'aide spécifié par TForm.HelpFile pour la fiche active.

Par défaut, HelpFile contient une chaîne vide et la méthode Help de l'application ne tient pas compte des tentatives d'affichage d'aide à moins que la fiche active ne soit associée à un fichier d'aide.

Pour que l'aide fonctionne correctement et qu'il appelle la fonction de gestion d'aide appropriée, insérez Vcl.HtmlHelpViewer, Vcl.WinHelpViewer ou une autre unité dans la clause uses de votre application. 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.

Voir aussi

Exemples de code