DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / Editeurs / Editeur d'états / Programmation d'un état
  • Présentation
  • Evénement "Ouverture" de l'état
  • Exécution de l'événement
  • Mot de passe du fichier de données source de l'état
  • Initialisation des variables
  • Exemples d'utilisation
  • Evénement "Lecture des données"
  • Exécution de l'événement
  • États basés sur un fichier texte
  • Exemples d'utilisation
  • Evénement "Filtre (tenir compte de l'enregistrement ?)"
  • Exécution de l'événement
  • Utilisation de l'événement Filtre
  • Exemples d'utilisation
  • Evénement "Fermeture" de l'état
  • Exécution de l'événement
  • Exemples d'utilisation
  • Evénement "Avant réimpression" de l'état
  • Exécution de l'événement
  • Exemples d'utilisation
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac CatalystUniversal Windows 10 App
Autres
Procédures stockées
Présentation
Les différents événements associés aux états sont les suivants (ordre d'apparition sous l'éditeur de code) :
Plusieurs événements sont associés aux états. Ces événements sont exécutés lors de l'impression de l'état.
Pour connaître l'ordre d'exécution de ces événements, consultez Enchaînement des événements associés aux états.
Evénement "Ouverture" de l'état

Exécution de l'événement

L'événement "Ouverture" de l'état est exécuté lors du lancement de l'impression de l'état.
Rappel : L'ordre d'exécution des événements au lancement d'un état (y compris lors d'un test) est le suivant :

Mot de passe du fichier de données source de l'état

Si le fichier de données source de l'état est protégé par un mot de passe, précisez ce mot de passe avant l'ouverture du fichier de données (grâce à la fonction HPasse par exemple).
Si le fichier de données n'a pas été ouvert avant l'impression de l'état, il est possible de préciser le mot de passe dans l'événement "Ouverture" de l'état.
WINDEV

Initialisation des variables

Lors de l'impression d'un état depuis le visualisateur de rapports, l'état est automatiquement ré-exécuté lorsque :
  • l'utilisateur change d'imprimante.
  • l'utilisateur utilise une des options d'export du ruban (Impression en mode PDF, HTML, dans un email, ...).
Dans ce cas, les données imprimées dans l'état peuvent être différentes de celles visualisées dans le visualisateur de rapports.
Il est conseillé d'initialiser les variables nécessaires à l'état dans l'événement "Ouverture de l'état" plutôt que dans le code du champ Bouton qui lance l'impression.

Exemples d'utilisation

Cet événement permet par exemple de :
  • déclarer les variables globales de l'état.
  • modifier les bornes de l'état avec les propriétés BorneMin et BorneMax.
  • initialiser les mots de passe des fichiers de données si nécessaire.
  • paramétrer la destination de l'impression (fonction iDestination).
  • passer des paramètres à la requête liée à l'état (fonction iInitRequêteEtat).
  • récupérer les paramètres passés à l'état.
  • changer la source de données de l'état.
Remarque : La fonction iImprime ne doit pas être utilisée dans l'événement "Ouverture" de l'état.
Evénement "Lecture des données"

Exécution de l'événement

Cet événement est exécuté lors du parcours des enregistrements à imprimer (dans la boucle d'impression), après la lecture de l'enregistrement.

États basés sur un fichier texte

Pour les états basés sur un fichier texte (avec lecture programmée), l'événement "Lecture des données" permet de lire les enregistrements présents dans le fichier texte pour les imprimer.

Exemples d'utilisation

Cet événement permet par exemple de :
  • effectuer des substitutions de blocs (car le prochain enregistrement à imprimer est connu).
  • sélectionner des enregistrements.
  • effectuer des calculs spécifiques.
Remarque : Cet événement renvoie Vrai s'il reste des enregistrements à imprimer et Faux s'il n'y a plus d'enregistrements à imprimer.
Pour ne pas imprimer un enregistrement, utilisez l'événement "Filtre (tenir compte de l'enregistrement ?)".
Evénement "Filtre (tenir compte de l'enregistrement ?)"

Exécution de l'événement

Cet événement est exécuté :
  • lors de l'initialisation de la source de données si elle est effectuée (pour les états basés sur un fichier de données, une vue ou une zone mémoire).
  • dans la boucle d'impression, après la lecture de l'enregistrement (cas des états sur requête ou sur un champ Table).
Cet événement permet de filtrer les enregistrements affichés dans l'état.

Utilisation de l'événement Filtre

Si cet événement contient des lignes de code, ces lignes de codes doivent renvoyer une valeur :
  • Annuler pour arrêter la lecture des enregistrements (et arrêter l'impression).
  • Vrai pour signifier que l'enregistrement vérifie le filtre et qu'il doit être imprimé.
  • Faux pour signifier que l'enregistrement ne vérifie pas le filtre et qu'il ne doit pas être imprimé.

Exemples d'utilisation

Cet événement permet par exemple de :
  • sélectionner des enregistrements.
  • réaliser des calculs avancés (total préalable, ...) pour les états basés sur les fichiers de données, les vues ou les zones mémoires.
Evénement "Fermeture" de l'état

Exécution de l'événement

Cet événement est exécuté lorsque l'impression de l'état est terminée, juste avant de fermer l'état.
Cet événement ne doit pas contenir de fonctions d'impression.
Remarque : La fonction iFichierEnCours permet de connaître le nom du fichier généré pour l'état (cas des exports en PDF, HTML, ...).

Exemples d'utilisation

Cet événement permet par exemple de :
  • connaître l'état de l'impression en cours (fonction iStatusImpressionEtat).
  • ouvrir une boîte de dialogue.
WINDEV
Evénement "Avant réimpression" de l'état

Exécution de l'événement

Cet événement est exécuté lors d'une impression effectuée depuis le visualisateur de rapports (impression directe ou export dans les formats PDF, XLS, RTF, ...).
Cet événement est exécuté après l'événement "Ouverture de l'état".
Si cet événement renvoie :
  • Vrai, la réimpression sera effectuée.
  • Faux, la réimpression sera annulée.
Remarques :
  • La fonction iDestination utilisée dans cet événement permet de connaître la destination de l'état (HTML, PDF, ...).
  • La fonction iFichierEnCours utilisée dans cet événement permet de connaître le nom du fichier généré pour l'état (cas des exports en PDF, HTML, ...).

Exemples d'utilisation

Cet événement permet par exemple de :
  • demander la qualité du PDF généré avant l'export au format PDF.
  • ajouter un filigrane.
  • demander un mot de passe avant l'impression ou l'export.
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 25/05/2022

Signaler une erreur ou faire une suggestion | Aide en ligne locale