PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

  • Présentation
  • Lancement d'une aide complète
  • Lancement d'une aide sur une fenêtre ou sur un champ
  • Lancer l'aide associée à une fenêtre
  • Lancer une aide sur un champ
  • Lancement d'une bulle d'aide avancée (aide contextuelle d'un champ)
  • Associer une aide contextuelle à un champ
  • Remarques
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Autres
Procédures stockées
Lancer un fichier d'aide (CHM ou HLP)
Présentation
Un fichier d'aide (CHM ou HLP) peut être lancé de différentes façons :
  • lancement d'une aide complète : permet d'ouvrir le fichier d'aide (affiche le sommaire).
    Ce type de lancement est réalisé le plus souvent à partir d'une option de menu (du type "? .. Aide générale").
  • lancement d'une aide sur une fenêtre ou un champ de l'application : permet d'ouvrir le fichier d'aide sur une page spécifique. Cette page présente par exemple les différentes options disponibles dans la fenêtre ou sur le champ.
    Le plus souvent, ce type de lancement est réalisé par l'appui sur la touche F1 ou par un bouton d'aide spécifique de la fenêtre.
  • affichage d'une bulle d'aide avancée (aide au format HLP uniquement) : cette aide contextuelle présente en détail l'utilisation d'un champ. Cette aide est affichée grâce à l'icône d'aide contextuelle ().
Lancement d'une aide complète
Le lancement de l'aide est réalisé grâce à la fonction WHelp. Il suffit de préciser le nom du fichier d'aide à lancer. Le fichier d'aide s'ouvre alors sur la première page de l'aide définie lors de la compilation.
Par exemple :
// Lancement de l'aide au format HLP
WHelp("MonAide.hlp")
// Lancement de l'aide au format CHM
WHelp("MonAideChm.chm")
// Lancement de l'aide dans une application multilangue
WHelp("MonAide" + Nation() + ".chm")
Lancement d'une aide sur une fenêtre ou sur un champ

Lancer l'aide associée à une fenêtre

Pour lancer l'aide associée à une fenêtre, il suffit d'utiliser la fonction WHelp en spécifiant l'identifiant de la page d'aide à afficher. Cet identifiant a été défini lors de la création du système d'aide (dans les caractéristiques de la page).
Remarque : Pour créer automatiquement le bouton d'aide affichant la page correspondant à une fenêtre, effectuez un "Drag and Drop" de la page d'aide concernée vers la fenêtre voulue.
L'exemple suivant permet de lancer la page d'aide de la fenêtre "FEN_Configuration_Imp". Cette page d'aide a pour identifiant 5.
// Lancement de l'aide au format HLP
WHelp("MonAide.hlp", 5)
// Lancement de l'aide au format CHM
WHelp("MonAideChm.chm", 5)

Lancer une aide sur un champ

Pour lancer une page d'aide sur un champ :
  1. Précisez le numéro de la page associée au champ dans la description du champ (onglet "Aide", champ "Numéro d'aide").
  2. Utilisez la fonction WHelp associée à la fonction NumHelp pour lancer la page d'aide (par exemple à partir d'un bouton d'aide).
L'exemple suivant est le code d'un bouton d'aide. Ce bouton permet de lancer la page d'aide associée au champ en cours de saisie.
// -- Code du bouton Aide
WHelp("MonAide.hlp", NumHelp(ChampEnCours()))
Lancement d'une bulle d'aide avancée (aide contextuelle d'un champ)

Associer une aide contextuelle à un champ

Pour associer une aide contextuelle à un champ :
  1. Affichez l'icône de l'aide contextuelle dans votre fenêtre (option "Icône d'aide contextuelle" dans l'onglet "Style" de la description de la fenêtre). Si votre fenêtre est une fenêtre détourée (cas par exemple de certains gabarits de la version 11), il est nécessaire de créer un bouton dans la fenêtre, associé à l'action prédéfinie "Aide contextuelle".
  2. Indiquez le fichier d'aide contextuelle à utiliser (onglet "Aide" de la description de la fenêtre). Ce fichier doit être au format HLP.
  3. Indiquez le numéro de la page d'aide associée au champ dans la description du champ (onglet "Aide", champ "Numéro d'aide").
Remarque : Le fichier d'aide contextuel associé à la fenêtre peut être connu et modifié avec la fonction FichierAide.

Remarques

  • Le fichier d'aide contextuelle doit avoir les caractéristiques suivantes :
    • pas d'entête de page.
    • pas de lien dans les pages de l'aide contextuelle, car ces liens ne fonctionneront pas.
  • Windows Vista et supérieur : Actuellement, Windows Vista ne contient pas le lanceur de l'aide au format Hlp (WinHelp32.exe). Les fichiers d'aide au format HLP ne sont pas utilisables sous Windows Vista. Une version de ce programme pour Windows Vista est en téléchargement dans le centre de téléchargement du site de Microsoft.
Version minimum requise
  • Version 9
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire