DokumentationAEM as a Cloud ServiceBenutzerhandbuch

Umfangsobjekt in benutzerdefinierten Funktionen

Last update: Mon Dec 30 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Benutzende
  • Entwickler

In der adaptiven Forms wird ein Bereichsobjekt als letztes Argument an Funktionen übergeben, wenn eine Regel ausgeführt wird. Es kann verwendet werden, um Formular-/Feldeigenschaften zu lesen und das Formular innerhalb der Funktionen zu ändern. Das Bereichsobjekt enthält ein schreibgeschütztes Proxy-Objekt für das Formular, das ausgelöste Ereignis und das Zielfeld. Auf Formular- und Feldeigenschaften kann über das Objekt „Umfang“ zugegriffen werden, indem $, z. B. scope.form.$id bzw. scope.field.$id, angehängt werden.

Formularänderungsfunktionen mit dem Bereichsobjekt

Das Bereichsobjekt verfügt über folgende Funktionen zum Ändern des Formulars:

Funktion
Syntax
Beschreibung
Code-Beispiel
setProperty
setProperty(any $element, any $payload)
Legt eine Eigenschaft des $element mithilfe des $payload fest.
Hier klicken um das Beispiel anzuzeigen.
Validieren
validate([any $element])
Führt die Validierung auf $element durch. Wenn kein -Element angegeben ist, wird das gesamte Formular validiert.
Hier klicken um das Beispiel anzuzeigen.
Zurücksetzen
reset([any $element])
Setzt die $element zurück. Wenn kein -Element bereitgestellt wird, wird das gesamte Formular zurückgesetzt.
Hier klicken um das Beispiel anzuzeigen.
importData
importData(any $payload)
Importiert Daten in das Formular und ersetzt alle vorhandenen Formulardaten.
Hier klicken um das Beispiel anzuzeigen.
exportData
exportData()
Gibt die Daten des Formulars zurück.
Hier klicken um das Beispiel anzuzeigen.
submitForm
submitForm(any $data [, boolean $validate_form = true, string $submit_as = 'multipart/form-data'])
Trigger für eine Formularübermittlung. Der $data gibt an, was gesendet werden soll, und definiert $submit_as den Inhaltstyp (standardmäßig „multipart/form-data„). Die optionale $validate_form bestimmt, ob das Formular validiert werden soll (Standard: true). Bei Erfolg wird submitSuccess ausgelöst; bei Misserfolg wird submitError ausgelöst.
Hier klicken um das Beispiel anzuzeigen.
setFocus
setFocus(any $element [, FocusOption $focusOption])
Setzt den Fokus auf den $element, der ein Bedienfeld oder ein Feld sein kann. Wenn kein Element bereitgestellt wird, wird der Fokus auf das Feld festgelegt, das die Regel ausgelöst hat. Der optionale $focusOption-Parameter (vom Aufzählungstyp FocusOption) gibt an, ob der Fokus auf „nextItem“ oder „previousItem“ relativ zu $element erfolgen soll. Wenn ein Bedienfeld angegeben ist, ist die Navigation auf dieses Bedienfeld beschränkt. Bei einem Feld erfolgt die Navigation im übergeordneten Bedienfeld.
Hier klicken um das Beispiel anzuzeigen.
dispatchevent
dispatchEvent(any $element, string $eventName [, any $payload])
Löst ein Ereignis vom Typ $eventName für das von $element angegebene Element aus. Wenn kein -Element bereitgestellt wird, wird das -Ereignis auf dem Formular gesendet. Die optionale $payload wird für Ausdrücke verfügbar gemacht, die das Ereignis behandeln.
Hier klicken um das Beispiel anzuzeigen.
markFieldAsInvalid
markFieldAsInvalid(string $fieldIdentifier, string $validationMessage [, any $option = {useId: true}])
Markiert das von $fieldIdentifier als ungültig identifizierte Feld und setzt die Überprüfungsmeldung auf $validationMessage. Der optionale $option gibt an, ob $fieldIdentifier als id, name oder dataRef interpretiert wird. Der Standardwert ist {useId: true}, und zu den unterstützten Werten gehören {useId: true}, {useDataRef: true} und {useQualifiedName: true}.
Hier klicken um das Beispiel anzuzeigen.

Siehe auch

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