自訂函式中的範圍物件

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

建立對象：

使用者
開發人員

在Adaptive Forms中，執行規則時，範圍物件會作為最後一個引數傳給函式。它可用來讀取表單/欄位屬性，以及從函式內修改表單。範圍物件包含表單、觸發事件和目標欄位的唯讀Proxy物件。可透過分別附加$ （例如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

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