PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

  • Présentation
  • Procédure locale
  • Procédures locales à une fenêtre
  • Procédures locales à une page
  • Procédures locales à un état
  • Création d'une procédure locale
  • Création depuis l'éditeur de code
  • Création depuis le volet "Explorateur de projet"
  • Afficher la liste des procédures locales
  • Suppression d'une procédure locale
  • Procédure locale publique ou privée
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
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 ou état) 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.
  • Versions 16 et supérieures
    Il est possible de créer des procédures multisyntaxes. Pour plus de détails, consultez Surcharge de prototype.
    Nouveauté 16
    Il est possible de créer des procédures multisyntaxes. Pour plus de détails, consultez Surcharge de prototype.
    Il est possible de créer des procédures multisyntaxes. Pour plus de détails, consultez Surcharge de prototype.
Versions 16 et supérieures
Universal Windows 10 App Cette fonctionnalité est disponible pour les applications Windows Phone.
Nouveauté 16
Universal Windows 10 App Cette fonctionnalité est disponible pour les applications Windows Phone.
Universal Windows 10 App Cette fonctionnalité est disponible pour les applications Windows Phone.
Versions 17 et supérieures
iPhone/iPad Cette fonctionnalité est disponible pour les applications iPhone/iPad.
Nouveauté 17
iPhone/iPad Cette fonctionnalité est disponible pour les applications iPhone/iPad.
iPhone/iPad Cette fonctionnalité est disponible pour les applications iPhone/iPad.
Versions 18 et supérieures
Universal Windows 10 App Cette fonctionnalité est disponible en mode Windows Store apps.
Widget Android Cette fonctionnalité est disponible en mode Widget Android.
Nouveauté 18
Universal Windows 10 App Cette fonctionnalité est disponible en mode Windows Store apps.
Widget Android Cette fonctionnalité est disponible en mode Widget Android.
Universal Windows 10 App Cette fonctionnalité est disponible en mode Windows Store apps.
Widget Android Cette fonctionnalité est disponible en mode Widget Android.
Versions 21 et supérieures
Universal Windows 10 App Cette fonctionnalité est disponible en mode Universal Windows 10 App.
Apple Watch Cette fonctionnalité est disponible en mode Apple Watch.
Nouveauté 21
Universal Windows 10 App Cette fonctionnalité est disponible en mode Universal Windows 10 App.
Apple Watch Cette fonctionnalité est disponible en mode Apple Watch.
Universal Windows 10 App Cette fonctionnalité est disponible en mode Universal Windows 10 App.
Apple Watch Cette fonctionnalité est disponible en mode Apple Watch.
Procédure locale
WINDEVEtats et RequêtesAndroidiPhone/iPadApple WatchWindows MobileUniversal Windows 10 AppJava

Procédures locales à une fenêtre

Les procédures locales déclarées dans une fenêtre peuvent être appelées depuis tous les traitements :
  • de la fenêtre,
  • des champs de la fenêtre,
  • des procédures locales associées à la fenêtre.
Ces procédures sont mémorisées dans la fenêtre.
Limites :
  • Les procédures locales d'une fenêtre ne peuvent pas être utilisées par ses fenêtres soeurs.
  • Les procédures locales déclarées dans une fenêtre fille ne peuvent pas être utilisées dans sa fenêtre mère.
WEBDEV - Code ServeurWEBDEV - Code Navigateur

Procédures locales à une page

Les procédures locales déclarées dans une page peuvent être appelées depuis tous les traitements :
  • de la page,
  • des champs de la page,
  • des procédures locales associées à la page.
Ces procédures sont mémorisées dans la page.
Il est possible de déclarer dans une page :
  • des procédures locales serveur,
  • des procédures locales navigateur.
Limite : Les procédures locales serveur d'une page ne peuvent pas appeler des procédures locales navigateur d'une page et inversement.
WINDEVWEBDEV - Code ServeurEtats et RequêtesWindowsiPhone/iPadWindows Mobile

Procédures locales à un état

Les procédures locales déclarées dans un état peuvent être appelées depuis tous les traitements :
  • de l'état,
  • des champs de l'état,
  • des procédures locales associées à l'état.
Ces procédures sont mémorisées dans l'état.
Création d'une procédure locale

Création depuis l'éditeur de code

Pour créer une procédure locale à l'élément en cours depuis l'éditeur de code :
  • Méthode 1 :
    • Sélectionnez l'option "Insertion .. Nouvelle procédure locale" (raccourci clavier [F4]).Sous le volet "Code", dans le groupe "Procédures", déroulez "Nouveau" et sélectionnez "Nouvelle procédure locale" (raccourci clavier [F4]).
      • WEBDEV - Code Serveur Pour créer une procédure locale serveur, sélectionnez l'option "Insertion .. Nouvelle procédure locale (Serveur)". WEBDEV - Code Serveur Pour créer une procédure locale serveur : sous le volet "Code", dans le groupe "Procédures", déroulez "Nouveau" et sélectionnez "Nouvelle procédure locale (Serveur)".
      • WEBDEV - Code Navigateur Pour créer une procédure locale navigateur, sélectionnez l'option "Insertion .. Nouvelle procédure locale (Navigateur)". WEBDEV - Code Navigateur Pour créer une procédure locale navigateur : sous le volet "Code", dans le groupe "Procédures", déroulez "Nouveau" et sélectionnez "Nouvelle procédure locale (Navigateur)".
    • Dans la fenêtre qui s'affiche :
      • Indiquez le nom de la procédure à créer.
      • Versions 21 et supérieures
        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.
        Nouveauté 21
        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.
        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.
      • Versions 19 et supérieures
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
        Nouveauté 19
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
  • Méthode 2 :
    • WINDEVWINDEV Mobile Pour créer une procédure locale : sélectionnez l'option "Créer une procédure .. Créer une procédure locale vide" du menu contextuel. WINDEVWINDEV Mobile Pour créer une procédure locale : sélectionnez l'option "Nouveau .. Nouvelle procédure locale" du menu contextuel.
    • WEBDEV - Code Serveur Pour créer une procédure locale serveur, sélectionnez l'option "Créer une procédure .. Créer une procédure locale (Serveur)". WEBDEV - Code Serveur Pour créer une procédure locale serveur, sélectionnez l'option "Nouveau .. Nouvelle procédure locale (Serveur)".
    • WEBDEV - Code Navigateur Pour créer une procédure locale navigateur, sélectionnez l'option "Créer une procédure .. Créer une procédure locale (Navigateur)". WEBDEV - Code Navigateur Pour créer une procédure locale navigateur, sélectionnez l'option "Nouveau .. Nouvelle procédure locale (Navigateur)".
    • Dans la fenêtre qui s'affiche :
      • Indiquez le nom de la procédure à créer.
      • Versions 21 et supérieures
        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.
        Nouveauté 21
        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.
        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.
      • Versions 19 et supérieures
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
        Nouveauté 19
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
  • Versions 22 et supérieures
    Méthode 3 : Pour créer une procédure locale :
    • Positionnez le curseur dans le traitement "Déclarations globales" de la fenêtre ou de la page.
    • Tapez le prototype de la procédure à créer.
    • Validez. La procédure locale est automatiquement créée.
    Nouveauté 22
    Méthode 3 : Pour créer une procédure locale :
    • Positionnez le curseur dans le traitement "Déclarations globales" de la fenêtre ou de la page.
    • Tapez le prototype de la procédure à créer.
    • Validez. La procédure locale est automatiquement créée.
    Méthode 3 : Pour créer une procédure locale :
    • Positionnez le curseur dans le traitement "Déclarations globales" de la fenêtre ou de la page.
    • Tapez le prototype de la procédure à créer.
    • Validez. La procédure locale est automatiquement créée.
Remarque : Pour transformer une partie de code déjà saisi dans une procédure locale en une procédure locale :
  1. Sélectionnez le code correspondant.
  2. Utilisez l'option "Créer une procédure .. Créer une procédure contenant le code sélectionné" du menu contextuel.Utilisez l'option "Nouveau .. Créer une procédure locale contenant le code sélectionné" du menu contextuel.
  3. Indiquez :
    • le nom de la procédure.
    • Versions 19 et supérieures
      la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
      Nouveauté 19
      la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
      la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
  4. La procédure est créée, le code correspondant est remplacé par l'appel de la procédure avec les paramètres nécessaires.
WEBDEV - Code ServeurWEBDEV - Code Navigateur Remarque : Si le code sélectionné est un code serveur, la procédure créée sera une procédure serveur. Si le code sélectionné est un code navigateur, la procédure créée sera une procédure navigateur.

Création depuis le volet "Explorateur de projet"

Pour créer une procédure locale depuis le volet "Explorateur de projet" :
  1. Sélectionnez l'élément associé à la procédure locale (fenêtre, page, état, ...).
  2. Déroulez les options de l'élément et sélectionnez l'option "Procédures locales" de l'élément.
  3. Affichez le menu contextuel et sélectionnez l'option "Nouvelle procédure locale".
  4. Dans la fenêtre qui s'affiche :
    • Indiquez le nom de la nouvelle procédure locale.
    • Versions 21 et supérieures
      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.
      Nouveauté 21
      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.
      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.
    • Versions 19 et supérieures
      Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
      Nouveauté 19
      Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
      Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure locale publique ou privée.
  5. Validez.
WEBDEV - Code Navigateur Pour créer une procédure locale navigateur, sélectionnez l'option "Nouvelle procédure locale navigateur".

Afficher la liste des procédures locales

Il est possible d'afficher la liste des procédures locales en sélectionnant l'option "Affichage .. Procédures locales" (raccourci clavier [F8]) de l'éditeur de code.
WEBDEV - Code ServeurWEBDEV - Code Navigateur Par défaut, l'option "Affichage .. Procédures locales" liste les procédures locales serveur. Il est possible d'afficher la liste des procédures locales navigateur en sélectionnant l'option "Affichage .. Procédures locales navigateur" (raccourci clavier [Alt] [F8]) de l'éditeur de code.
Pour afficher la liste des procédures locales, utilisez la touche [F8] sous l'éditeur de code. La liste des procédures locales est affichée dans l'explorateur de projet.
WEBDEV - Code ServeurWEBDEV - Code Navigateur Par défaut, la touche [F8] liste les procédures locales serveur. Pour afficher la liste des procédures locales navigateur, utilisez la combinaison de touches [Alt] [F8] sous l'éditeur de code. La liste des procédures locales est affichée dans l'explorateur de projet.
Suppression d'une procédure locale
Pour supprimer une procédure locale depuis le volet "Explorateur de projet" :
  1. Sélectionnez l'élément associé à la procédure locale (fenêtre, page, état, ...).
  2. Déroulez les options de l'élément.
  3. Déroulez l'option "Procédures locales" de l'élément.
  4. Sélectionnez la procédure voulue.
  5. Affichez le menu contextuel de la procédure et sélectionnez l'option "Supprimer".
Procédure locale publique ou privée
Une procédure locale 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 locale en la rendant "Privée".
Versions 19 et supérieures
Lors de la création d'une procédure locale, il est possible de spécifier si la procédure est publique ou privée.
Nouveauté 19
Lors de la création d'une procédure locale, il est possible de spécifier si la procédure est publique ou privée.
Lors de la création d'une procédure locale, 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 locale :
  1. Sélectionnez la procédure locale 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é.
Versions 16 et supérieures
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.
Nouveauté 16
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.
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 locales privées ou publiques :
L'utilisation de procédures locales privées ou publiques a un impact notamment dans les composants externes. En effet, seules les procédures explicitement publiques (utilisant le mot-clé PUBLIC dans leur prototype) présentes dans un composant externe pourront pas être accessibles depuis le projet intégrant ce composant.
Version minimum requise
  • Version 12
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire