PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

  • Présentation
  • Créer un état paramétré
  • Présentation
  • Exemple
  • Imprimer un état paramétré
  • Exemple
  • Conseil
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
Présentation
Lors de l'impression d'un état, il est possible de passer des paramètres à cet état. L'état est alors appelé "État paramétré".
Par exemple, votre état correspond à un mailing publicitaire envoyé à tous les clients de votre société. Avant d'exécuter cet état, le texte du mailing est saisi dans un champ. Ce texte correspond alors à un paramètre attendu par l'état.
Etat Paramétré
Versions 18 et supérieures
iPhone/iPad Cette fonctionnalité est désormais disponible pour les applications iPhone/iPad.
Nouveauté 18
iPhone/iPad Cette fonctionnalité est désormais disponible pour les applications iPhone/iPad.
iPhone/iPad Cette fonctionnalité est désormais disponible pour les applications iPhone/iPad.
Créer un état paramétré

Présentation

La création d'un état paramétré est composée de plusieurs étapes :
  1. Création d'un état.
  2. Modification de cet état pour gérer les paramètres :
    • Récupération des paramètres dans le code "Ouverture" de l'état à l'aide de la syntaxe suivante :
      PROCEDURE <NomEtat>(<NomParam1>, ...
      <NomParam2>= "<ValeurParDéfautParam2>", ...
      ...
      <NomParamN> = "<ValeurParDéfautParamN>")

      Rappel : Certains paramètres passés à une procédure peuvent être optionnels. Lors de la déclaration de la procédure, les paramètres optionnels doivent être décrits en dernière position (à droite), avec une valeur par défaut précédée du signe "=". Pour plus de détails, consultez Paramètre d'une procédure.
    • Utilisation de ces paramètres dans les champs de l'état.
  3. Modification si nécessaire de l'application afin de spécifier les différents paramètres.
  4. Impression de l'état avec passage des paramètres. Pour plus de détails, consultez le paragraphe Imprimer un état paramétré.

Exemple

La programmation nécessaire à la création d'un état paramétré est illustrée par l'exemple suivant :
  • L'état "ETAT_EtatParam" correspond à un mailing publicitaire envoyé aux clients.
  • Cet état attend en paramètre le texte du mailing saisi dans le champ de saisie "SAI_TexteMailing".
Mise en place :
  1. Créez l'état "ETAT_EtatParam" (option "Fichier .. Nouveau .. Etat mailing"). Cet état est lié au fichier "Client" de votre analyse. Pour plus de détails sur la création d'un état, consultez Les états.Créez l'état "ETAT_EtatParam" :
    • Cliquez sur Nouveau parmi les boutons d'accès rapide.
    • Dans la roue qui s'affiche, cliquez sur "Etat". La fenêtre de création d'un nouvel élément s'affiche : cliquez sur "Etat" puis sur "Etat".
    • L'assistant de création d'un état se lance.
    • Dans l'assistant, sélectionnez "Mailing" et validez.
      Cet état est lié au fichier "Client" de votre analyse. Pour plus de détails sur la création d'un état, consultez Les états.
  2. Personnalisez cet état.
  3. Dans le traitement "Ouverture" de l'état "ETAT_EtatParam", saisissez le code suivant :
    // Récupérer le paramètre passé à l'état et
    // passer un paramètre par défaut pour le test de l'état
    PROCEDURE ETAT_EtatParam(sTexte = "Valeur par défaut")
  4. Dans le bloc Corps de cet état, ajoutez le champ Libellé "LIB_TexteMailing" permettant d'afficher le texte du mailing.
  5. Dans le traitement "Avant impression" du champ "LIB_TexteMailing", saisissez le code suivant :
    // Récupérer le texte du mailing
    LIB_TexteMailing = sTexte
  6. Dans une fenêtre de l'application, ajoutez :
    • le champ de saisie "SAI_TexteMailing" permettant à l'utilisateur de saisir le texte du mailing.
    • le bouton "BTN_Imprimer" permettant de lancer l'impression de l'état.
Imprimer un état paramétré
Pour imprimer un état paramétré, il suffit de :
  1. Paramétrer la destination de l'impression de l'état grâce à la fonction iAperçu (aperçu avant impression, impression dans un fichier HTML, ...).
  2. Préciser les paramètres suivants grâce à la fonction iImprimeEtat :
    • le nom de l'état à imprimer.
    • les paramètres.
Remarques :
  • Si l'état est basé sur une vue HFSQL, le nom de cette vue HFSQL doit être indiqué dans la fonction iImprimeEtat, avant les paramètres. Pour plus de détails, consultez Etat sur une vue HFSQL.
  • Si l'état est basé sur une zone mémoire, le nom de cette zone mémoire doit être indiqué dans la fonction iImprimeEtat, avant les paramètres. Pour plus de détails, consultez Etat sur une zone mémoire.
  • Si l'état est un état borné, la valeur des bornes (minimales et/ou maximales) doit être indiquée dans la fonction iImprimeEtat, avant les paramètres. Pour plus de détails, consultez Etat borné.
Remarque : A partir de la version 19, HFSQL est le nouveau nom de HyperFileSQL.

Exemple

L'état "ETAT_EtatParam" correspond à un mailing publicitaire envoyé aux clients. Cet état attend en paramètre le texte du mailing saisi dans le champ de saisie "SAI_TexteMailing".
L'état "ETAT_EtatParam" s'imprime lors d'un clic sur le bouton "BTN_Imprimer".
Dans cet exemple, le code du bouton "BTN_Imprimer" est le suivant :
// Ouvrir la fenêtre d'aperçu
iAperçu()
// Imprimer l'état avec passage de paramètre
iImprimeEtat(ETAT_EtatParam, SAI_TexteMailing)
Conseil
Pour tester un état paramétré directement depuis l'éditeur d'états, il est conseillé de donner une valeur par défaut aux paramètres dans la déclaration des paramètres.
Par exemple, pour tester l'état de l'exemple précédent, saisissez le code suivant dans le traitement "Ouverture" de l'état "ETAT_EtatParam" :
// Récupérer le paramètre passé à l'état et
// passer un paramètre par défaut pour le test de l'état
PROCEDURE ETAT_EtatParam(sTexte = "Valeur par défaut")
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire