自定义函数中的范围对象

Last update: Mon Nov 04 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

适用对象：
Experience Manager as a Cloud Service

创建对象：

用户
开发人员

在自适应Forms中，范围对象在执行规则时作为最后一个参数传递给函数。它可用于读取表单/字段属性，以及从函数内修改表单。作用域对象包含表单、触发的事件和目标字段的只读代理对象。通过分别附加$（例如scope.form.$id和scope.field.$id），可以使用范围对象访问表单和字段属性。

使用范围对象的表单修改函数

范围对象具有下列表单修改功能：

函数

语法

描述

代码示例

setProperty

setProperty(any $element, any $payload)

使用$payload设置$element的属性。

单击此处查看示例。

验证

validate([any $element])

在$element上运行验证。如果未提供任何元素，则会验证整个表单。

单击此处查看示例。

重置

reset([any $element])

重置$element。如果未提供元素，则会重置整个表单。

单击此处查看示例。

importData

importData(any $payload)

将数据导入表单，并替换任何现有的表单数据。

单击此处查看示例。

exportData

exportData()

返回表单数据。

单击此处查看示例。

提交表单

submitForm(any $data [, boolean $validate_form = true, string $submit_as = 'multipart/form-data'])

触发表单提交。 $data参数指定要提交的内容，$submit_as定义内容类型（默认为“multipart/form-data”）。可选的$validate_form确定是否应当验证表单（默认值： true）。成功时触发submitSuccess；失败时触发submitError。

单击此处查看示例。

setFocus

setFocus(any $element [, FocusOption $focusOption])

将焦点设置为$element，它可以是面板或字段。如果未提供任何元素，则焦点将设置为触发规则的字段。可选$focusOption参数（枚举类型FocusOption）指定是关注相对于$element的“nextItem”还是“previousItem”。如果指定了面板，则导航将限制到该面板；对于字段，导航会在父面板中进行。

单击此处查看示例。

dispatchEvent

dispatchEvent(any $element, string $eventName [, any $payload])

在$element指定的元素上调度类型为$eventName的事件。如果未提供任何元素，则会在表单上调度事件。可选$payload可供处理该事件的表达式使用。

单击此处查看示例。

markFieldAsInvalid

markFieldAsInvalid(string $fieldIdentifier, string $validationMessage [, any $option = {useId: true}])

将$fieldIdentifier标识的字段标记为无效，并将验证消息设置为$validationMessage。可选的$option参数指定$fieldIdentifier是解释为id、name还是dataRef。默认值为{useId: true}，支持的值包括{useId: true}、{useDataRef: true}和{useQualifiedName: true}。

单击此处查看示例。

另请参阅

recommendation-more-help

fbcff2a9-b6fe-4574-b04a-21e75df764ab