WebForm
La classe WebForm contient des fonctions et des propriétés permettant de gérer vos composants de pages Qodly. Les objets 4D.WebForm sont instanciés avec la commande webForm.
Historique
| Release | Modifications |
|---|---|
| 20 R6 | Ajout de enableState() et disableState() |
| 20 R2 | Ajout |
Commandes et fonctions
qui sont disponibles directement en tant que propriétés |
| .disableState( state : string) désactive le rendu de l'état state dans la page web courante |
| .enableState( state : string ) active le rendu de l'état state dans la page web courante |
| .setError( msg : string) envoie msg comme message d'erreur à la page web |
| .setMessage( msg : string) envoie msg comme message d'information à la page web |
| .setWarning( msg : string) envoie msg comme message d'avertissement à la page web |
.componentName
.componentName : 4D.WebFormItem
Description
Les composants des pages web sont des objets qui sont disponibles directement en tant que propriétés de ces pages web.
Les objets retournés sont de la classe 4D.WebFormItem. Ces objets possèdent des fonctions que vous pouvez utiliser pour gérer vos composants de manière dynamique.
Exemple
shared singleton Class constructor()
var myForm : 4D.WebForm
var component : 4D.WebFormItem
myForm:=webForm //renvoie la page web en tant qu'objet, chaque propriété est un composant
component:=myForm.myImage //renvoie le composant myImage de la page web
Bien que myForm n'affiche pas les propriétés typiques de l'objet lorsqu'il est examiné dans le débogueur, il se comporte comme s'il s'agissait de l'objet webForm réel. Vous pouvez interagir avec les propriétés et les fonctions de l'objet sous-jacent webForm à travers myForm. Par exemple, vous pouvez manipuler dynamiquement des composants de page ou transmettre des messages à des pages web en utilisant des fonctions spécialisées comme myForm.setMessage().
.disableState()
.disableState( state : string)
| Paramètres | Type | Description | |
|---|---|---|---|
| state | string | -> | Nom de l'état à désactiver dans la page web |
Description
La fonction .disableState() désactive le rendu de l'état state dans la page web courante.
Cette fonction ne fait rien si :
- le state n'est actuellement pas activé dans la page web,
- le state n'existe pas pour la page web.
Si vous activez ou désactivez plusieurs états dans la même fonction utilisateur, toutes les modifications sont envoyées en même temps au client une fois que la fonction se termine.
Pour plus d'informations sur les états des pages web, veuillez vous référer à la section States dans la documentation de Qodly.
.enableState()
.enableState( state : string )
| Paramètres | Type | Description | |
|---|---|---|---|
| state | string | -> | Nom de l'état à activer sur les pages web |
Description
La fonction .enableState() active le rendu de l'état state dans la page web courante.
Cette fonction ne fait rien si :
- le state a déjà été activé sur la page web,
- le state n'existe pas pour la page web.
Si vous activez ou désactivez plusieurs états dans la même fonction utilisateur, toutes les modifications sont envoyées en même temps au client une fois que la fonction se termine.
Pour plus d'informations sur les états des pages web, veuillez vous référer à la section States dans la documentation de Qodly.
Exemple
Vous activez un état spécifique appelé "wrongCredentials" en cas d'erreur sur votre page de connexion :
Function authenticationError()
If (Session.info.type#"remote")
Web Form.enableState("wrongCredentials")
End if
.setError()
.setError( msg : string)
| Paramètres | Type | Description | |
|---|---|---|---|
| msg | string | -> | Message d'erreur à afficher dans la page web |
Description
La fonction .setError() envoie msg comme message d'erreur à la page web.
La fonction renvoie une réponse avec un statut 200 OK et un objet __WEBFORM dans le corps avec une propriété __NOTIFICATION.message fixée à msg et un __NOTIFICATION.type fixé à "error".
Exemple
shared singleton Class constructor()
exposed function myError()
var myForm : 4D.WebForm
myForm:=web Form
myForm.setError("My error message")
Si la fonctionnalité Provide feedback est activée pour l'événement, le message msg s'affiche en toast rouge au bas de la page web et disparaît automatiquement après 5 secondes :
.setMessage()
.setMessage( msg : string)
| Paramètres | Type | Description | |
|---|---|---|---|
| msg | string | -> | Message d'information à afficher dans la page web |
Description
La fonction .setMessage() envoie msg comme message d'information à la page web.
La fonction renvoie une réponse avec un statut 200 OK et un objet __WEBFORM dans le corps avec une propriété __NOTIFICATION.message fixée à msg et un __NOTIFICATION.type fixé à "message".
Exemple
shared singleton Class constructor()
exposed function myMessage()
var myForm : 4D.WebForm
myForm:=web Form
myForm.setMessage("My information message")
Si la fonctionnalité Provide feedback est activée pour l'événement, le message msg s'affiche en toast vert au bas de la page web et disparaît automatiquement après 5 secondes :
.setWarning()
.setWarning( msg : string)
| Paramètres | Type | Description | |
|---|---|---|---|
| msg | string | -> | Message d'avertissement à afficher dans la page web |
Description
La fonction .setWarning() envoie msg comme message d'avertissement à la page web.
La fonction renvoie une réponse avec un statut 200 OK et un objet __WEBFORM dans le corps avec une propriété __NOTIFICATION.message fixée à msg et un __NOTIFICATION.type fixé à "warning".
Exemple
shared singleton Class constructor()
exposed function myWarning()
var myForm : 4D.WebForm
myForm:=web Form
myForm.setWarning("My warning message")
Si la fonctionnalité Provide feedback est activée pour l'événement, le message msg s'affiche en toast jaune au bas de la page web et disparaît automatiquement après 5 secondes :
