Scope object in custom functions

Last update: November 6, 2024
  • Applies to:
  • Experience Manager as a Cloud Service

CREATED FOR:

  • User
  • Developer

In Adaptive Forms, a scope object is passed as the last argument to functions when a rule is executed. It can be used to read form/field properties and modify the form from within the functions. The scope object contains a read-only proxy object for the form, the triggered event, and the target field. Form and field properties can be accessed using the scope object by appending $, for example, scope.form.$id and scope.field.$id, respectively.

Form modification functions using scope object

Scope object has following functions for form modification:

FunctionSyntaxDescriptionCode sample
setPropertysetProperty(any $element, any $payload)Sets a property of the $element using the $payload.Click here to view the example.
validatevalidate([any $element])Runs validation on $element. If no element is provided, it validates the entire form.Click here to view the example.
resetreset([any $element])Resets the $element. If no element is provided, it resets the entire form.Click here to view the example.
importDataimportData(any $payload)Imports data into the form, replacing any existing form data.Click here to view the example.
exportDataexportData()Returns the form’s data.Click here to view the example.
submitFormsubmitForm(any $data [, boolean $validate_form = true, string $submit_as = 'multipart/form-data'])Triggers a form submission. The $data parameter specifies what to submit, and $submit_as defines the content type (defaults to ‘multipart/form-data’). The optional $validate_form determines if the form should be validated (default: true). Upon success, submitSuccess is fired; on failure, submitError is fired.Click here to view the example.
setFocussetFocus(any $element [, FocusOption $focusOption])Sets focus to the $element, which can be a panel or field. If no element is provided, focus is set to the field that triggered the rule. The optional $focusOption parameter (of enum type FocusOption) specifies whether to focus on the ‘nextItem’ or ‘previousItem’ relative to $element. If a panel is specified, navigation is restricted to that panel; with a field, navigation happens in the parent panel.Click here to view the example.
dispatchEventdispatchEvent(any $element, string $eventName [, any $payload])Dispatches an event of type $eventName on the element specified by $element. If no element is provided, the event is dispatched on the form. The optional $payload is made available to expressions handling the event.Click here to view the example.
markFieldAsInvalidmarkFieldAsInvalid(string $fieldIdentifier, string $validationMessage [, any $option = {useId: true}])Marks the field identified by $fieldIdentifier as invalid and sets the validation message to $validationMessage. The optional $option parameter specifies if $fieldIdentifier is interpreted as id, name, or dataRef. The default value is {useId: true}, and supported values include {useId: true}, {useDataRef: true}, and {useQualifiedName: true}.Click here to view the example.

See Also

Experience Manager