Formulaire:ref:

Ci-dessous la liste des fonctions utilisables avec une instance de formulaire :

Function Description
getConfiguration() Récupère la configuration complète.
getElement() Récupère l'élément DOM du formulaire.
getFieldByName() Récupère un champ donné.
getFields() Récupère tous les champs de ce formulaire.
getName() Récupère le nom du formulaire.
onSubmit() Branche une fonction sur la soumission du formulaire.

Récupérer la configuration:ref:

Fonction

getConfiguration()

Retour

Array

Description

Récupère la configuration complète du formulaire. Il s'agit en grande partie de la configuration TypoScript, vous pouvez donc récupérer certaines valeurs que vous aurez personnalisé au préalable.

Exemple :

var formConfiguration = form.getConfiguration();
var message = formConfiguration['settings']['defaultErrorMessage'];

Récupérer l'élément:ref:

Fonction

getElement()

Retour

HTMLFormElement

Description

Récupère l'élément DOM du formulaire. Vous pouvez ensuite le manipuler selon vos besoins.

Exemple :

var formElement = form.getElement();
formElement.classList.add('some-class');

Récupérer un champ donné:ref:

Fonction

getFieldByName(name)

Retour

Fz.FullField

Paramètres

  • name : le nom du champ.

Description

Récupère un champ donné, que vous pouvez ensuite manipuler à votre guise.

Exemple :

var fieldEmail = form.getFieldByName('email');

Récupérer tous les champs:ref:

Fonction

getFields()

Retour

Object<Fz.FullField>

Description

Récupère tous les champs de ce formulaire.

Exemple :

var fields = form.getFields();
for (var fieldName in fields) {
    // ...
}

Récupérer le nom du formulaire:ref:

Fonction

getName()

Retour

String

Description

Récupère le nom du formulaire.

Exemple :

var message = 'The form ' + form.getName() + ' has been submitted.';

Se brancher sur la soumission du formulaire:ref:

Fonction

onSubmit(callback)

Retour

/

Paramètres

  • callback : fonction appelée à la soumission du formulaire. Si elle retourne false, la soumission du formulaire sera annulée.

Description

Branche une fonction sur la soumission du formulaire. Notez que la fonction ne sera pas appelée si la soumission du formulaire est bloquée (à cause d'un champ invalide par exemple).

La fonction peut renvoyer false si la soumission doit être bloquée pour une raison quelconque.

Exemple :

form.onSubmit(function() {
    var foo = bar();
    if (true === foo) {
        return false;
    }
});