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à di $element utilizzando $payload.
Fare clic qui per visualizzare l'esempio.
convalida
validate([any $element])
Esegue la convalida su $element. Se non viene fornito alcun elemento, viene convalidato l’intero modulo.
Fare clic qui per visualizzare l'esempio.
reimposta
reset([any $element])
Reimposta $element. Se non viene fornito alcun elemento, viene ripristinato 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.
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. Il parametro $data specifica cosa inviare e $submit_as definisce il tipo di contenuto (impostazione predefinita: 'multipart/form-data'). L'elemento facoltativo $validate_form determina se il modulo deve essere convalidato (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])
Attiva $element, che può essere un pannello o un campo. Se non viene fornito alcun elemento, lo stato attivo viene impostato sul campo che ha attivato la regola. Il parametro facoltativo $focusOption (di tipo enum FocusOption) specifica se concentrarsi su 'nextItem' o 'previousItem' relativo a $element. Se è specificato un pannello, la navigazione è limitata a tale pannello; con un campo, la navigazione avviene nel pannello principale.
Fare clic qui per visualizzare l'esempio.
dispatchEvent
dispatchEvent(any $element, string $eventName [, any $payload])
Invia un evento di tipo $eventName sull'elemento specificato da $element. Se non viene fornito alcun elemento, l’evento viene inviato sul modulo. L'elemento facoltativo $payload è disponibile per le espressioni che gestiscono l'evento.
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 imposta il messaggio di convalida su $validationMessage. Il parametro facoltativo $option specifica se $fieldIdentifier viene interpretato come id, name o dataRef. Il valore predefinito è {useId: true} e i valori supportati includono {useId: true}, {useDataRef: true} e {useQualifiedName: true}.
Fare clic qui per visualizzare l'esempio.

Consulta anche

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