FORM LOAD

4D v19.8

FORM LOAD


FORM LOAD ( {laTable ;} formulaire {; *} )

Paramètre	Type	Description
laTable	Table	Table du formulaire à charger (si omis, charger un formulaire projet)
formulaire	Chaîne, Objet	Nom du formulaire table ou projet à utiliser, ou Chemin POSIX (chaîne) d'un fichier .json décrivant le formulaire, ou Objet décrivant le formulaire
*	Opérateur	Si passé = la commande s’applique à la base hôte lorsqu’elle est exécutée depuis un composant (paramètre ignoré hors de ce contexte)

Description

La commande FORM LOAD vous permet de charger le formulaire en mémoire dans le process courant afin d'imprimer des données ou d'analyser son contenu. Il ne peut y avoir qu'un seul formulaire courant par process.

Dans le paramètre formulaire, vous pouvez passer soit :

le nom du formulaire (formulaire projet ou formulaire table) à utiliser,
le chemin (en syntaxe POSIX) d'un fichier .json valide contenant la description du formulaire à utiliser (voir Chemin d'accès du formulaire),
un objet contenant la description du formulaire à utiliser.

Impression de données

Pour que cette commande puisse être exécutée, une tâche d'impression doit avoir été ouverte au préalable à l'aide de la commande OPEN PRINTING JOB. La commande OPEN PRINTING JOB effectue un appel implicite à la commande FORM UNLOAD, il est donc nécessaire d’exécuter FORM LOAD dans ce contexte. Une fois chargé, le formulaire devient le formulaire d’impression courant. Toutes les commandes de gestion des objets, et en particulier la commande Print object, travaillent avec ce formulaire.

Si un formulaire d’impression avait déjà été chargé au préalable (via un appel précédent à la commande FORM LOAD), il est refermé et remplacé par formulaire. Vous pouvez ouvrir et refermer plusieurs formulaires dans la même session d’impression. Changer de formulaire d’impression via la commande FORM LOAD ne génère pas de saut de page, il revient au développeur de les gérer.

Seul l’événement formulaire On Load est exécuté durant l’ouverture du formulaire, ainsi que les méthodes des objets du formulaire. Les autres événements formulaire sont ignorés. L’événement formulaire On Unload est exécuté à l’issue de l’impression.

Pour préserver la cohérence graphique des formulaires, il est conseillé d’appliquer la propriété d’apparence "Impression" sur toutes les plates-formes.

Le formulaire d’impression courant est automatiquement refermé lorsque la commande CLOSE PRINTING JOB est appelée.

Note de compatibilité : Dans les versions de 4D antérieures à la v14, la commande FORM LOAD (nommée OUVRIR FORMULAIRE IMPRESSION) acceptait une chaîne vide dans le paramètre formulaire afin de refermer le formulaire projet courant. Cette syntaxe n’est désormais plus prise en charge et retourne une erreur. Vous devez désormais utiliser la commande FORM UNLOAD ou la commande CLOSE PRINTING JOB pour refermer le formulaire.

Analyse du contenu du formulaire

Cette possibilité consiste à charger un formulaire hors-écran à des fins d’analyse. Pour effectuer cette action, il suffit d’appeler FORM LOAD en-dehors d’un contexte de tâche d’impression. Dans ce cas, les événements formulaire ne sont pas exécutés.

FORM LOAD peut être utilisé avec les commandes FORM GET OBJECTS et OBJECT Get type afin d’effectuer tout type de traitement sur le contenu du formulaire. Il est ensuite impératif d'appeler la commande FORM UNLOAD afin de décharger le formulaire de la mémoire.

A noter que dans tous les cas, le formulaire à l’écran reste chargé (il n’est pas touché par la commande FORM LOAD), il n’est pas nécessaire de le recharger après un FORM UNLOAD.

Si la commande est exécutée depuis un composant, elle charge par défaut les formulaires du composant. Si vous passez le paramètre *, la méthode chargera les formulaires de la base hôte.

Rappel : Dans le contexte du hors-écran, n'oubliez pas d'appeler FORM UNLOAD afin d'éviter tout risque de saturation de la mémoire.

Exemple 1

Appel d’un formulaire projet en tâche d’impression :

 OPEN PRINTING JOB

 FORM LOAD("print_form")

     // exécution des événements et des méthodes objet

Exemple 2

Appel d’un formulaire table en tâche d’impression :

 OPEN PRINTING JOB

 FORM LOAD([People];"print_form")

     // exécution des événements et des méthodes objet

Exemple 3

Analyse du contenu d’un formulaire pour effectuer un traitement sur les zones de saisie de texte :

 FORM LOAD([People];"my_form") 

     // sélection du formulaire sans exécution des événements ni des méthodes

 FORM GET OBJECTS(tabNomsObj;tabPtrObj;tabPages;*)

 For($i;1;Size of array(tabNomsObj))

       If(OBJECT Get type(*;tabNomsObj{$i})=Object type text input)

           //… traitement

       End if

 End for

 FORM UNLOAD //ne pas oublier

Exemple 4

L'exemple suivant retourne le nombre d'objets contenu dans un formulaire dynamique (JSON) :

 ARRAY TEXT(objectsArray;0)

 ARRAY POINTER(variablesArray;0)

 ARRAY INTEGER(pagesArray;0)

 

 FORM LOAD("/RESOURCES/OutputForm.json") //on charge le formulaire

 FORM GET OBJECTS(objectsArray;variablesArray;pagesArray;Form all pages+Form inherited)

 

 ALERT("Le formulaire contient "+String(Taille tableau(objectsArray))+" objets") //afficher le nombre d'objets

Résultat :

Voir aussi

Current form name
FORM UNLOAD
LISTBOX GET OBJECTS
OBJECT Get type
Print object