カスタム関数のスコープオブジェクト

Last update: Tue Oct 14 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

適用対象：
Experience Manager as a Cloud Service

作成対象：

ユーザー
開発者

アダプティブFormsでは、ルールが実行される際に、スコープオブジェクトが関数の最後の引数として渡されます。このパラメーターを使用して、関数の中からフォームやフィールドのプロパティを読み取り、フォームを変更することができます。スコープオブジェクトには、フォーム、トリガーイベント、ターゲットフィールドの読み取り専用プロキシオブジェクトが含まれます。フォームおよびフィールドのプロパティには、scope オブジェクトを使用して、$ を追加してアクセスできます。たとえば、それぞれ scope.form.$id および scope.field.$id を追加します。

スコープオブジェクトを使用したフォーム変更関数

Scope オブジェクトには、フォームを変更するための次の関数があります。

関数

構文

説明

コードサンプル

setProperty

setProperty(any $element, any $payload)

$payload を使用して、ターゲットフィールドにプロパティを設定します。

ここをクリックして例を表示します。

validate

validate([any $element])

ターゲットフィールドで検証を実行します。ターゲットが指定されていない場合はフォーム全体で検証を実行し、検証エラーの配列を返します。

ここをクリックして例を表示します。

reset （非推奨）

reset([any $element])

廃止。代わりに dispatchEvent($target, 'reset') を使用します。ターゲットフィールドをリセットします。ターゲットが指定されていない場合は、フォーム全体をリセットします。

ここをクリックして例を表示します。

importData

importData(any $payload)

既存のフォームデータを置き換えて、データをフォームにインポートします。 qualifiedName が指定されている場合、データはそのコンテナフィールドにのみ読み込まれます。

ここをクリックして例を表示します。

exportData

exportData()

フォームのデータを返します。

ここをクリックして例を表示します。

submitForm

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

フォーム送信をトリガーします。 $payload パラメーターを介して送信する内容を指定し、$contentType パラメーターを使用してコンテンツタイプを設定できます。デフォルトでは、データは multipart/form-data として送信されます。オプションの $validateForm パラメーターは、送信前にフォームを検証する必要があるかどうかを指定します（デフォルトは true）。成功した場合は submitSuccess が実行され、失敗した場合は submitError が実行されます。

ここをクリックして例を表示します。

setFocus

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

ターゲットフィールド（パネルまたはフォームフィールド）にフォーカスを設定します。ターゲットが指定されていない場合、ルールをトリガーしたフィールドにフォーカスが設定されます。オプションの $focusOption パラメーターは、ターゲットに関連する次の項目または前の項目にフォーカスを移動するかどうかを指定します。サポートされている値：'nextItem'、'previousItem'。パネルと共に使用する場合、ナビゲーションはそのパネルに制限されます。フィールドと共に使用すると、そのフィールドの親パネル内でナビゲーションが行われます。

ここをクリックして例を表示します。

dispatchEvent

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

$eventName によって決定された要素でタイプ $target のイベントをディスパッチします。ターゲットが指定されていない場合、イベントがフォームにディスパッチされます。オプションの $payload は、イベントを処理する式で使用できます。オプションの $dispatch パラメーターは、イベントの伝達動作を制御します。

ここをクリックして例を表示します。

markFieldAsInvalid

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

$fieldIdentifier によって識別されたフィールドを無効としてマークし、$validationMessage を表示します。オプションの $option パラメーターは、$fieldIdentifier を id、dataRef または qualifiedName のいずれとして解釈するかを指定します。デフォルト値は {useId: true} です。サポートされている値：{useId: true}、{useDataRef: true}、{useQualifiedName: true}。

ここをクリックして例を表示します。

カスタム関数のスコープオブジェクト

スコープオブジェクトを使用したフォーム変更関数

関連トピック