フォームクライアントAPIの活用
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
フォームクライアントAPIは、Sitecoreデザイナーページでカスタマイズされたコンポーネントを開発者が開発するのを支援するSPEAKアイテムです。フォームクライアントAPIはフォームからフォームフィールドを取得することができます。
フォームクライアントAPIはフォームデザイナーページのレイアウトや、フォームデザイナーページのダイアログボックス(例えば条件 編集 ダイアログボックス)に追加できます。
レイアウトにフォームクライアントAPIを追加してください
フォームクライアントAPIをフォームデザイナーページのレイアウトに追加するには:
- デザインレイアウトのウィンドウに行き、「 AddRendering」をクリックします。
- 選択されたレンダリングダイアログボックスでFormClientAPIを検索し(またはsitecore/client/Applications/FormsBuilder/Components/Layouts/Renderings/Compositesに移動し)、それをクリックして追加をクリックします。
APIパラメータの追加
フォームクライアントAPIの設定を設定するには:
-
ページのPageSettingsにアクセスし、右クリックして 追加をクリックし、「 新しいアイテム」をクリックします。
-
「 新しいアイテムを追加 」ダイアログボックスで「 FormClientApi-Parameters」を検索してクリックし、「 追加」をクリックします。
-
パラメータを編集するには、FormClientApi-Parameters項目をダブルクリックしてください。
-
Fields Accessor Option項目内のフォームフィールドの取得方法を設定するには、以下の設定を設定してください:
-
IncludedFieldTypeIds - どのフィールドタイプが取得されるかを定義します。フィールドタイプを含めていない場合、そのフィールドタイプのフィールドは返されません。例えば、単行テキスト型のフィールドを取得したくない場合は、ツリーリストから選択しないでください。
-
Format - 取得したフィールドオブジェクトの変換を定義します。フィールドオブジェクトのmodelプロパティを抽出し、定義された形式に従って新しいオブジェクトに変換します。
例えば、フィールドオブジェクトの性質は次のようになります: idx, itemId, model, parentId, rendering settings。
modelプロパティで利用可能なプロパティは、conditionSettings、cssClass、itemId、name、templateIdです。
左側はmodelで利用可能な性質を指定します。右側では変換後の性質の名前を指定します。
例えば、次のフォーマットに基づく返されたフィールドオブジェクトは以下の通りです:
{
fieldId:
fieldName:
}
!注すべてのプロパティを持つフィールドオブジェクトを取得したい場合は、形式を指定しないでください。
-
PageCodeからフォームフィールドを取得する
あるフォームの利用可能なフォームフィールドを取得するには:
-
ページのPageCode JavaScriptファイルにアクセスし、フォームクライアントのID APIにアクセスしてください。
-
フォームフィールドを取得するには以下のJavaScriptコードを使ってください:
var fields = this.FormClientApi.getFields();