Appel de l'aide HTML depuis les applications

Remonter à Activation de l'aide dans les applications

Remarque : La plupart des fonctionnalités d'aide décrites dans cette section peuvent être utilisées dans les applications Delphi et C++ de la même façon. Dans Delphi, par exemple, vous devez insérer l'unité Vcl.HtmlHelpViewer dans la clause uses de votre application, tandis que dans C++, vous devez ajouter la directive #include Vcl.HtmlHelpViewer.hpp.

L'EDI de RAD Studio fournit des options -- disponibles dans la boîte de dialogue Options de projet et dans l'inspecteur d'objets -- qui définissent quelles sont les rubriques d'aide de quels fichiers d'aide à afficher. Avec les classes de gestion d'aide fournies dans les bibliothèques RTL et VCL, ces options fournissent les fonctionnalités suivantes qui vous aident à présenter l'aide dans vos applications RAD Studio sans aucune programmation de code manuelle :

1. Affichage de l'aide invoquée par l'appui sur F1

L'appui sur F1 est le moyen standard d'activer l'aide dans les applications. L'EDI de RAD Studio génère automatiquement, en utilisant les bibliothèques RTL et VCL, le code qui gère l'affichage de l'aide invoquée par l'appui sur F1. L'inspecteur d'objets et d'autres fonctionnalités de l'EDI supportent le paramétrage des options qui définissent le fichier d'aide et la rubrique d'aide à afficher lors de l'appui sur F1.

Les rubriques Gestion par défaut de l'aide F1 dans les applications VCL et Personnalisation de l'aide F1 dans les applications VCL décrivent comment définir les paramètres des appels aux fonctions de gestion de l'aide.

2. Affichage de l'aide invoquée par l'appui sur des boutons

Vous pouvez utiliser les boutons d'aide -- du type Vcl.Buttons.TBitBtn et avec Kind = bkHelp -- pour afficher les rubriques d'aide.

3. Affichage de l'aide invoquée par des clics sur des commandes de menu

RAD Studio fournit quatre actions de gestion d'aide standard (Vcl.StdActns.THelpContents, Vcl.StdActns.THelpOnHelp, Vcl.StdActns.THelpTopicSearch et Vcl.StdActns.THelpContextAction), qui peuvent être assignées à vos éléments de menu ou à vos boutons de barre d'outils.

4. Affichage de l'aide à propos des commandes de menu sélectionnées

Quand vous mettez en surbrillance un élément de menu, vous pouvez appuyer sur F1 pour afficher une rubrique d'aide associée.

5. Affichage d'invites à propos d'objets d'écran pointés

Vous pouvez utiliser la propriété Hint pour présenter des invites contextuelles à propos de fiches, de contrôles et d'autres objets d'écran. De telles invites sont aussi connues comme aide "Qu'est-ce que c'est ?".

Voir aussi

• Activation de l'aide dans les applications
• Types d'aide HTML
• Gestion par défaut de l'aide F1 dans les applications VCL
• Personnalisation de l'aide F1 dans les applications VCL
• Affichage de l'aide avec les boutons d'aide
• Association de l'aide avec les commandes de menu
• Affichage de l'aide à propos des commandes de menu sélectionnées
• Utilisation de la propriété Hint pour afficher l'aide contextuelle des objets d'écran
• Interfaces système d'aide
• Utilisation de l'aide dans une application VCL