FormFillerSettings 型の別名

型宣言

• オプション applyAfterFailedValidation?: "confirm" | "reject" | "apply" | Function

  [適用]ボタンをクリックした後にフォームの検証が失敗した場合に実行するアクションの種類。

  既定値

  confirm

  サンプル

  検証が失敗した場合、変更の適用を拒否します。

   options.formFiller = {
   applyAfterFailedValidation: 'reject'
   }

  サンプル

  カスタム関数を実行し、変更を拒否します。

   options.formFiller = {
   applyAfterFailedValidation: function() {
   alert('Validation failed, changes rejected.');
   return false;
   }
   }

  サンプル

  カスタム関数を実行し、変更を承諾します。

   options.formFiller = {
   applyAfterFailedValidation: function() {
   alert('Validation failed, but changes will be accepted.');
   return true;
   }
   }

• オプション beforeApplyChanges?: ((formFiller: any) => boolean)

  • • (formFiller: any): boolean

    • フィールドの検証を成功した後に[適用]ボタンがクリックされると、beforeApplyChangesイベントハンドラが呼び出されます。変更の適用をキャンセルする場合、falseを返します。

      サンプル

      // 変更を適用する前に、アドレス値を2つのアドレスフィールドに分割します。 
      var viewer = new DsPdfViewer("#root");
      viewer.options.formFiller = {
       beforeApplyChanges: function(formFiller) {
       var addr1 = formFiller.getFieldByName('Addr1');
       var addr2 = formFiller.getFieldByName('Addr2');
       if(addr1 && addr2) {
       var s = addr1.fieldValue;
       var nlInd = s.indexOf('\n');
       if(nlInd !== -1) {
       var firstPart = s.substring(0, nlInd).replace(/\n+/g, ' ');
       var secondPart = s.substr(nlInd).replace(/\n+/g, ' ');
       addr1.fieldValue = firstPart;
       addr2.fieldValue = secondPart;
       } else {
       addr2.fieldValue = '';
       }
       formFiller.onFieldChanged(addr1);
       formFiller.onFieldChanged(addr2);
       }
       return true;
       },
      };

      パラメータ

      • formFiller: any

      戻り値 boolean

• オプション beforeFieldChange?: ((field: WidgetAnnotation, formFiller: any) => boolean)

  • • (field: WidgetAnnotation, formFiller: any): boolean

    • beforeFieldChangeイベントハンドラは、フィールド値が変更される直前に呼び出されます。フィールド値の変更をキャンセルする場合、falseを返します。

      パラメータ

      • field: WidgetAnnotation

      • formFiller: any

      戻り値 boolean

• オプション layout?: "Auto" | "OneColumn" | "TwoColumns"

  フォームフィラーダイアログのレイアウトの種類。

  既定値

  デフォルトは「Auto」です。小さなデバイス画面の場合、レイアウトは「OneColumn」に切り替わります。

  サンプル

   options.formFiller = {
   layout: 'OneColumn'
   }

• mappings: { [fieldName: string]: FormFieldMapping }

  フォームフィールドのマッピング、キー-フィールド名、値- FormFieldMapping。

  • [fieldName: string]: FormFieldMapping

• オプション onInitialize?: ((formFiller: any) => void)

  • • (formFiller: any): void

    • onInitializeイベントハンドラーは、フィールドのリストがロードおよび初期化されたが、まだ描画されていない後に呼び出されます。

      サンプル

      options.formFiller = {
       // フィールドをロードした後、2つのアドレスフィールドを結合します。
       onInitialize: function(formFiller) {
       var addr1 = formFiller.getFieldByName('Addr1');
       var addr2 = formFiller.getFieldByName('Addr2');
       if(addr1 && addr2) {
       if(addr2.fieldValue) {
       addr1.fieldValue = addr1.fieldValue + '\n' + addr2.fieldValue;
       addr2.fieldValue = '';
       formFiller.onFieldChanged(addr1);
       formFiller.onFieldChanged(addr2);
       }
       }
       }
      }

      パラメータ

      • formFiller: any

      戻り値 void

• オプション title?: string

  ダイアログのタイトル。

  既定値

  「Form Filler」

  サンプル

   options.formFiller = {
   title: 'Please fill the form'
   };

• オプション validator?: ((fieldValue: string | string[], field: WidgetAnnotation, args: { caller: ValidationCallerType }) => boolean | string)

  • • (fieldValue: string | string[], field: WidgetAnnotation, args: { caller: ValidationCallerType }): boolean | string

    • フィールドのマッピング設定にvalidateOnInputフラグが含まれる場合に、変更を保存する前またはユーザー入力時に各フィールドに対して呼び出される「validator」関数。検証エラーに関するメッセージを含む文字列値を返すことができ、このメッセージはUIに表示されます。成功した結果の場合はtrueまたはnullを返します。

      パラメータ

      • fieldValue: string | string[]

      • field: WidgetAnnotation

      • args: { caller: ValidationCallerType }

        • caller: ValidationCallerType

      戻り値 boolean | string