DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / WLangage / Syntaxe WLangage / Procédures WLangage
  • Définition
  • Procédure globale
  • Procédures globales et collections de procédures
  • Création d'une procédure globale
  • Création depuis l'éditeur de code
  • Création depuis le volet "Explorateur de projet"
  • Afficher la liste des procédures globales
  • Suppression d'une procédure globale
  • Suppression depuis l'éditeur de code
  • Suppression depuis le volet "Explorateur de projet"
  • Test d'une procédure globale
  • Depuis l'éditeur de code
  • Depuis le volet "Explorateur de projet"
  • Procédure globale publique ou privée
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
Définition
Les procédures peuvent être de deux types :
  • Procédure globale : utilisable dans tous les traitements du projet. Cette procédure globale est mémorisée dans le projet.
  • Procédure locale : utilisable dans tous les traitements dépendant de l'objet (fenêtre, page, état, champ) dans lequel cette procédure a été déclarée. Cette procédure locale est mémorisée dans l'objet.
Important : Il ne faut pas déclarer deux procédures avec le même nom (notamment une procédure globale et une procédure locale).
Rappel :
  • En WLangage, il n'existe pas de distinction entre les procédures et les fonctions. Les syntaxes de déclaration et d'utilisation décrites pour les procédures sont les mêmes pour les fonctions.
  • Il est possible de créer des procédures multisyntaxes. Pour plus de détails, consultez Surcharge de prototype.
Procédure globale
Etats et Requêtes

Procédures globales et collections de procédures

Les procédures globales sont mémorisées dans des collections de procédures, associées au projet. Chaque collection de procédures est un fichier ".WDG".
Les procédures globales contenues dans une collection de procédures peuvent être appelées depuis tous les événements/traitements :
  • du projet,
  • de la fenêtre ou de la page (événements de la fenêtre / de la page, de ses champs et traitements des procédures locales associées),
  • de l'état (événements de l'état, de ses champs et traitements des procédures locales associées).
Conseil : Si une procédure est utilisée par une seule fenêtre ou page, il est conseillé de décrire cette procédure comme locale à la fenêtre ou à la page. La fenêtre / page est alors "indépendante".
Création d'une procédure globale

Création depuis l'éditeur de code

Pour créer une procédure globale depuis l'éditeur de code :
  • Méthode 1 :
    1. Affichez l'éditeur de code (touche F2 sur un élément de votre fenêtre ou de votre page).
    2. Sous le volet "Code", dans le groupe "Procédures", déroulez "Nouveau" et sélectionnez "Nouvelle procédure globale" (raccourci clavier Shift F4).
    3. Indiquez le nom de la collection de procédures contenant la procédure globale et validez.
      Remarque : Si le projet contient déjà une collection de procédure, il est possible de sélectionner la collection de procédures existante.
    4. Dans la fenêtre qui s'affiche :
      • Indiquez le nom de la procédure globale à créer.
      • L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
        Pour plus de détails, consultez Documentation automatique des procédures.
      • Indiquez la portée de la procédure (visibilité). Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
      • Indiquez le rôle de la procédure : Non défini, Métier, UI. Par défaut, une procédure a un rôle "Non défini".
    5. Validez. L'éditeur de code affiche le code de la procédure qui vient d'être créée.
    Remarque : Il est également possible d'utiliser l'option "Nouveau .. Nouvelle procédure globale vide" du menu contextuel d'une ligne de code.
  • Méthode 2 :
    1. Affichez l'éditeur de code (touche F2 sur un élément de votre fenêtre ou de votre page).
    2. Positionnez-vous à la fin du code d'une procédure globale.
    3. Tapez le prototype de la procédure à créer.
    4. Validez. La procédure est automatiquement créée.
Pour transformer une partie de code déjà saisi dans une procédure globale en une procédure globale :
  1. Sélectionnez le code correspondant.
  2. Utilisez l'option "Nouveau .. Créer une procédure globale contenant le code sélectionné" du menu contextuel.
  3. Saisissez le nom de la nouvelle collection de procédures ou sélectionnez la collection de procédures utilisée.
  4. Dans la fenêtre qui s'affiche :
    • Indiquez le nom de la procédure globale à créer.
    • L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
      Pour plus de détails, consultez Documentation automatique des procédures.
    • Indiquez la portée de la procédure (visibilité). Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
    • Indiquez le rôle de la procédure : Non défini, Métier, UI. Par défaut, une procédure a un rôle "Non défini".
  5. Validez. La procédure est créée, le code correspondant est remplacé par l'appel de la procédure avec les paramètres nécessaires.

Création depuis le volet "Explorateur de projet"

Pour créer une procédure globale depuis le volet "Explorateur de projet" :
  1. Sélectionnez le dossier "Procédures".
  2. Choisissez la collection de procédure dans laquelle la procédure doit être créée :
    • Créez si nécessaire une nouvelle collection de procédures (option "Nouveau" du dossier "Procédures").
    • Sélectionnez la collection de procédures voulue.
  3. Dans le menu contextuel de la collection de procédures, sélectionnez l'option "Nouvelle procédure globale".
  4. Dans la fenêtre qui s'affiche :
    • Indiquez le nom de la nouvelle procédure globale.
    • L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
      Pour plus de détails, consultez Documentation automatique des procédures.
    • Indiquez la portée de la procédure (visibilité). Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
    • Indiquez le rôle de la procédure : Non défini, Métier, UI. Par défaut, une procédure a un rôle "Non défini".
  5. Validez.

Afficher la liste des procédures globales

Pour afficher la liste des procédures globales, utilisez la combinaison de touches Ctrl + F8 de l'éditeur de code.
Les procédures globales sont affichées dans le volet "Explorateur de projet" si ce volet est affiché.
Suppression d'une procédure globale

Suppression depuis l'éditeur de code

Pour supprimer une procédure globale depuis l'éditeur de code :
  1. Cliquez sur le bandeau de la procédure dans l'éditeur de code.
  2. Dans le menu contextuel, sélectionnez "Supprimer".

Suppression depuis le volet "Explorateur de projet"

Pour supprimer une procédure globale depuis le volet "Explorateur de projet" :
  1. Sélectionnez le dossier "Procédures".
  2. Sélectionnez la collection de procédures voulue.
  3. Sélectionnez la procédure globale voulue.
  4. Affichez le menu contextuel de la procédure et sélectionnez l'option "Supprimer".
Test d'une procédure globale

Depuis l'éditeur de code

Pour tester une procédure globale :
  1. Affichez la procédure globale sous l'éditeur de code.
  2. Cliquez sur le bouton "GO" présent parmi les boutons d'accès rapide.
  3. La fenêtre de description du test de la procédure s'affiche. Cette fenêtre permet de :
    • Saisir les différents paramètres de la procédure.
    • Lancer le test de la procédure (bouton "Tester la procédure").
    • Vérifier la valeur de retour.

Depuis le volet "Explorateur de projet"

Pour tester une procédure globale :
  1. Sélectionnez le dossier "Procédures" dans le volet "Explorateur de projet".
  2. Sélectionnez le nom de la procédure globale à tester.
  3. Sélectionnez l'option "Tester la procédure" du menu contextuel.
  4. La fenêtre de description du test de la procédure s'affiche. Cette fenêtre permet de :
    • Saisir les différents paramètres de la procédure.
    • Lancer le test de la procédure (bouton "Tester la procédure").
    • Vérifier la valeur de retour.
Procédure globale publique ou privée
Une procédure globale est publique par défaut : elle est accessible depuis n'importe quel code.
Dans certains cas, il est nécessaire de restreindre l'accès à une procédure globale en la rendant "Privée". Dans ce cas, la procédure globale et accessible uniquement par une autre procédure globale présente dans la collection de procédures.
Lors de la création d'une procédure globale, il est possible de spécifier si la procédure est publique ou privée.
Pour modifier le mode d'accès à une procédure globale :
  1. Sélectionnez la procédure globale dans le volet "Explorateur de projet".
  2. Dans le menu contextuel de la procédure, sélectionnez le nouveau mode d'accès :
    • publique.
    • privé.
La couleur du bandeau de la procédure change en fonction de son mode d'accès :
  • début de bandeau rouge : procédure privée.
  • début de bandeau habituel : procédure publique.
Remarque : Composant externe et procédures globales privées :
L'utilisation de procédures globales privées ou publiques a un impact notamment dans les composants externes. En effet, seules les procédures explicitement privées (utilisant le mot-clé PRIVEE dans leur prototype) présentes dans un composant externe ne pourront pas être utilisées directement par le projet intégrant ce composant.
Version minimum requise
  • Version 12
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 04/04/2024

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