1. Sitecoreフォーム

フォームクライアントAPIの操作

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

フォーム クライアントAPIは、開発者がSitecore Designerページ内でカスタマイズされたコンポーネントを開発するのを支援するSPEAKアイテムです。フォームクライアントAPIを使用すると、フォームからフォームフィールドを取得できます。

フォーム クライアントAPIは、フォーム デザイナ ページのレイアウトと、フォーム デザイナ ページのダイアログ ボックス ( Edit conditionsダイアログ ボックスなど) に追加できます。

フォームクライアントAPIをレイアウトに追加する

フォーム クライアントAPIをフォーム デザイナ ページのレイアウトに追加するには:

  1. デザインレイアウトウィンドウに移動し、「 AddRendering」をクリックします。

  2. Selected Renderingsダイアログボックスで、FormClientAPI を検索(またはsitecore/client/Applications/FormsBuilder/Components/Layouts/Renderings/Compositesに移動)し、クリックしてAddをクリックします。

APIパラメータを追加する

フォームクライアントAPIの設定を構成するには:

  1. ページのPageSettingsに移動し、右クリックして「 Add」をクリックし、「 New Item」をクリックします。

  2. Add New Itemダイアログボックスで、「 FormClientApi-Parameters」を検索してクリックし、「 Add」をクリックします。

  3. パラメータを編集するには、FormClientApi-Parameters項目をダブルクリックします。

    Edit the FormClientApi parameters.

  4. Fields Accessor Optionアイテムのフォームフィールドを取得する方法を設定するには、次の使用可能な設定を構成します。

    • IncludedFieldTypeIds - 取得するフィールドの種類を定義します。フィールド タイプを含めない場合、そのフィールド タイプのフィールドは返されません。たとえば、1行テキスト型のフィールドを取得しない場合は、ツリー リストから選択しないでください。

      IncludedFieldTypeIds

    • Format - 取得されたフィールドオブジェクトの変換を定義します。フィールドオブジェクトのmodelプロパティを抽出し、定義された形式に従って新しいオブジェクトに変換します。

      たとえば、フィールドオブジェクトのプロパティは次のようになります。 idx, itemId, model, parentId, rendering settings。

      modelプロパティで使用できるプロパティは、conditionSettings、cssClass、itemId、name、およびtemplateIdです。

      左側で、modelで使用できるプロパティを指定します。右側で、変換後のプロパティの名前を指定します。

      The format settings.

      たとえば、次の形式に基づいて返されるフィールド オブジェクトです。

      {

fieldId: <the value of itemId of the field>

fieldName: <the value of name of the field>

}
      メモ

      すべてのプロパティを持つフィールド オブジェクトを取得する場合は、形式を指定しないでください。

PageCodeからフォームフィールドを取得する

フォームの使用可能なフォームフィールドを取得するには:

  1. ページのPageCode JavaScriptファイルに移動し、そのIDでForm Client APIにアクセスします。

  2. 次のJavaScriptコードを使用して、フォームフィールドを取得します。

    var fields = this.FormClientApi.getFields();

この記事を改善するための提案がある場合は、 お知らせください!