Vcl.Forms.TApplication.HelpCommand

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function HelpCommand(Command: Integer; Data: NativeInt): Boolean;

C++

bool __fastcall HelpCommand(int Command, NativeInt Data);

Propriétés

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


Description

Donne accès aux commandes d'aide de l'interface de programmation d'application (API) des fonctions de gestion d'aide natives HTMLHelp, WinHelp ou autre.

Utilisez HelpCommand pour envoyer une commande à HTMLHelp, WinHelp ou aux autres fonctions de gestion d'aide natives. Avant d'envoyer la commande d'aide au moteur d'aide (Windows) natif, HelpCommand génère un événement OnHelp sur la fiche active ou sur l'objet TApplication. La commande est enfin expédiée aux fonctions de gestion d'aide natives (HTMLHelp ou WinHelp) s'il n'existe pas de gestionnaire d'événements OnHelp.

Pour que HelpCommand fonctionne et qu'elle appelle la fonction de gestion d'aide native appropriée, insérez dans la clause uses de votre application l'unité 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.

Voir aussi