System.HelpIntfs.RegisterViewer
Delphi
function RegisterViewer(const newViewer: ICustomHelpViewer;
out Manager: IHelpManager): Integer;
C++
extern DELPHI_PACKAGE int __fastcall RegisterViewer(const _di_ICustomHelpViewer newViewer, /* out */ _di_IHelpManager &Manager);
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | System.HelpIntfs |
Description
Recense la visionneuse d'aide pour recevoir les requêtes d'aide.
Appelez RegisterViewer pour recenser une visionneuse d'aide avec le système d'aide. Une application peut recenser autant de visionneuses que nécessaire. L'ordre dans lequel les visionneuses d'aide sont recensées est important, car chaque requête d'aide force le système d'aide RTL à consulter les visionneuses dans l'ordre du recensement et à donner la requête d'aide à la première visionneuse qui prétend pouvoir la gérer. Une application peut redéfinir ce comportement pour les requêtes d'aide basées sur les mots-clé et les requêtes d'affichage d'un sommaire en fournissant un objet sélecteur d'aide.
Passez l'objet visionneuse d'aide dans le paramètre newViewer.
RegisterViewer renvoie un objet Gestionnaire d'aide dans le paramètre Manager ; la visionneuse d'aide utilise cet objet pour interagir avec le système d'aide.
La valeur renvoyée de RegisterViewer est True si la visionneuse a été correctement recensée, False sinon.
La bibliothèque VCL définit l'unité Vcl.HtmlHelpViewer, qui fournit une interface Delphi à la visionneuse d'aide externe HTMLHelp. HTMLHelp est la fonction de gestion d'aide native de Windows. Pour recenser la visionneuse d'aide basée sur HTMLHelp dans votre application, vous pouvez insérer dans la clause uses de votre application l'unité Vcl.HtmlHelpViewer. La section initialization de l'unité Vcl.HtmlHelpViewer appelle RegisterViewer pour recenser la visionneuse d'aide créée :
initialization
HelpViewer := THtmlHelpViewer.Create;
System.HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);
Ici :
- Le constructeur THtmlHelpViewer.Create de la première ligne crée en interne l'objet visionneuse d'aide
HelpViewerIntf. - La seconde ligne appelle la fonction RegisterViewer, qui recense cette visionneuse d'aide.
La fonction System.HelpIntfs.GetHelpSystem globale peut être appelée à partir d'autres unités pour accéder aux méthodes des systèmes d'aide de la visionneuse d'aide recensée.