Oggetto ambito nelle funzioni personalizzate

In Adaptive Forms, un oggetto ambito viene passato come ultimo argomento alle funzioni quando viene eseguita una regola. Può essere utilizzato per leggere le proprietà di un modulo/campo e modificare il modulo dall’interno delle funzioni. L'oggetto ambito contiene un oggetto proxy di sola lettura per il modulo, l'evento attivato e il campo di destinazione. È possibile accedere alle proprietà del modulo e del campo utilizzando l'oggetto ambito aggiungendo $, ad esempio scope.form.$id e scope.field.$id, rispettivamente.

Funzioni di modifica dei moduli tramite l’oggetto ambito

L’oggetto ambito dispone delle seguenti funzioni per la modifica del modulo:

Funzione
Sintassi
Descrizione
Esempio di codice
setProperty
setProperty(any $element, any $payload)
Imposta una proprietà sul campo di destinazione utilizzando $payload.
Fare clic qui per visualizzare l'esempio.
convalida
validate([any $element])
Esegue la convalida nel campo di destinazione. Esegue la convalida sull'intero modulo se non viene fornita alcuna destinazione e restituisce una matrice di errori di convalida.
Fare clic qui per visualizzare l'esempio.
reimposta (obsoleto)
reset([any $element])
Obsoleto. Utilizza invece dispatchEvent($target, 'reset'). Reimposta il campo di destinazione o, se non viene fornita alcuna destinazione, reimposta l'intero modulo.
Fare clic qui per visualizzare l'esempio.
importData
importData(any $payload)
Importa i dati nel modulo, sostituendo eventuali dati del modulo esistenti. Se si specifica qualifiedName, i dati vengono importati solo nel campo contenitore.
Fare clic qui per visualizzare l'esempio.
exportData
exportData()
Restituisce i dati del modulo.
Fare clic qui per visualizzare l'esempio.
submitForm
submitForm(any $data [, boolean $validate_form = true, string $submit_as = 'multipart/form-data'])
Attiva l'invio di un modulo. È possibile specificare cosa inviare tramite il parametro $payload e impostare il tipo di contenuto tramite il parametro $contentType. I dati vengono inviati come multipart/form-data per impostazione predefinita. Il parametro facoltativo $validateForm specifica se il modulo deve essere convalidato prima dell'invio (impostazione predefinita: true). Al completamento, submitSuccess viene attivato; in caso di errore, submitError viene attivato.
Fare clic qui per visualizzare l'esempio.
setFocus
setFocus(any $element [, FocusOption $focusOption])
Imposta lo stato attivo sul campo di destinazione, che può essere un pannello o un campo modulo. Se non viene fornita alcuna destinazione, lo stato attivo viene impostato sul campo che ha attivato la regola. Il parametro facoltativo $focusOption specifica se l'elemento successivo o precedente relativo alla destinazione deve essere attivato. Valori supportati: 'nextItem', 'previousItem'. Se utilizzato con un pannello, la navigazione è limitata a tale pannello. Se utilizzata con un campo, la navigazione avviene all’interno del pannello principale di tale campo.
Fare clic qui per visualizzare l'esempio.
dispatchEvent
dispatchEvent(any $element, string $eventName [, any $payload])
Invia un evento di tipo $eventName sull'elemento determinato da $target. Se non viene fornita alcuna destinazione, l’evento viene inviato sul modulo. L'elemento facoltativo $payload è disponibile per le espressioni che gestiscono l'evento. Il parametro facoltativo $dispatch controlla il comportamento di propagazione degli eventi.
Fare clic qui per visualizzare l'esempio.
markFieldAsInvalid
markFieldAsInvalid(string $fieldIdentifier, string $validationMessage [, any $option = {useId: true}])
Contrassegna il campo identificato da $fieldIdentifier come non valido e visualizza $validationMessage. Il parametro facoltativo $option specifica se $fieldIdentifier viene interpretato come id, dataRef o qualifiedName. Il valore predefinito è {useId: true}. Valori supportati: {useId: true}, {useDataRef: true}, {useQualifiedName: true}.
Fare clic qui per visualizzare l'esempio.

Consulta anche

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab