www.dextsolution.com
DEXTUPLOAD
X5
リファレンス > component

## getWithCredentials

- マルチモジュール 2.2.0.0以上

- 説明

  クッキー、認証ヘッダ、TLSクライアント資格情報などの資格情報を持ってサーバーに要求を試みることができるかどうかを返します。

- 形式

      isWith = component.getWithCredentials();

- リターンタ

  資格情報を使用することができている場合true、なければfalseである。

## setWithCredentials

- マルチモジュール 2.2.0.0以上

- 説明

  クッキー、認証ヘッダ、TLSクライアント資格情報などの資格情報を持ってサーバーに要求を試みることができるかどうかを設定する。

  ドメインクッキーを共有するためには、サーバーのCORS設定だけではなく、パラメータをtrueにするsetWithCredentialsメソッドを呼び出す必要があります。

  trueに設定すると、ターゲットサーバーは、Access-Control-Allow-Originヘッダーの値を「*」に指定できず、許可する対象を明確に記録しなければならない。また、Access-Control-Allow-Credentialsヘッダをtrueに設定する必要がする必要がある。

      function onDX5Created(id) {
          var dx = dx5.get()
          // 資格情報を共有するように設定する。
          dx.setWithCredentials(true);
      }

- 形式

      component.setWithCredentials(isWith);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  isWith | String | クロスドメインリクエストで資格情報を共有するには、true、またはfalseを設定します。

## enableResumingUpload

- 1.0.0.0以上

- 説明

  アップロード時に、継続を使用するかどうかを設定します。ファイルのアップロードの文脈では、継続とは、アップロードを中断して再試行するのではなく、アップロードを完全にキャンセルしたりブラウザを閉じたりしても、同じファイルを途中でサーバーにアップロードし続けるオプションを指します。

  - チャンクされたファイルアップロードでのみ動作するため、'EXTS' と 'AWSS3' フォーマットのみをサポートします。
  - ブラウザのキャッシュをクリアすれば、ファイルが連続した状態でも最初からアップロードされる。
  - Amazon S3では最大7日間しかファイルを保存できません。

      function onDX5Created(id) {
        var dx = dx5.get(id);
        // 大容量アップロードの方法で使用する。
        dx.setUploadMode("EXTS");
        // アップロードブロック単位を10MBに設定します。
        dx.setUploadBlockSize(10 * 1024 * 1024);
        // 続い上げるを使用していない。
        dx.enableResumingUpload(false);
      }

- 形式

      component.enableResumingUpload(enable);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  enable | Boolean | trueの場合続いて上げるを使用する。デフォルト値はtrueである。

## isUsingProgressDialog

- 1.0.0.0以上

- 説明

  製品で提供される独自の進行状況ウィンドウを使用するかを返します。

  DEXTUploadX5で基本的にサポートしている進行状況ウィンドウを使用しない場合はuseProgressDialog関数を使用することができる。

  代わりにgetUploadStatus関数を使用してアップロードの進行情報をスクリプトで別々に得ることができる。

      // メイン進行ウィンドウを使用していない。
      dx.useProgressDialog(false);
      // 進行ウィンドウ安保のでgetUploadStatus関数を使用してアップロードの進行情報を得る。
      var status = dx.getUploadStatus();
      // 名前: status.currentName
      // フルスピード: status.totalSpeed
      // アップロードが完了した数: status.completeCount
      // 全体数: status.totalCount
      // 現在のファイル転送速度: status.currentRate
      // 現在のファイルの転送されたサイズ: status.currentSendSize
      // 現在のファイルのサイズ: status.currentSize
      // 現在のファイルの転送時間: status.currentTime
      // 現在のファイルの残り時間: status.remainedCurrentTime
      // ファイル全体レート: status.totalRate
      // ファイル全体の送信されたサイズ: status.totalSendSize
      // ファイル全体のサイズ: status.totalSize
      // ファイル全体の転送時間: status.totalTime
      // ファイル全体の残り時間: status.remainedTotalTime

- 形式

      using = component.isUsingProgressDialog();

- リターンタ

  製品自体進行状況ウィンドウを使用するかどうか

## isWheelEnabled

- 3.1.0.0以上

- 説明

  マウスホイールスクロールを使用するかどうかを返します。

  デフォルトはtrueです。

- 形式

      using = component.isWheelEnabled();

- リターンタ

  true, false

## setWheelEnabled

- 3.1.0.0以上

- 説明

  マウスホイールスクロールを有効または無効にします。

  デフォルトはtrueです。

  マウスのホイールスクロール機能はデスクトップブラウザとのみ見なされ、モバイル環境ではサポートされていません。

      // マウスのホイールスクロールを無効にします。
      dx.setWheelEnabled(false);

- 形式

      component.setWheelEnabled(enable);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  enable | Boolean | マウスホイールスクロールを使用するかどうか

## createColumn

- 3.2.0.0以上

- 説明

  「createColumn」メソッドは、「GRID」スタイルのコンポーネントにカスタム列を追加します。 「createColumn」メソッドは、仮想ファイルを追加するコードの前に適用する必要があります。

      var dx = dx5.get(id);
      dx.createColumn({ key: "col01", display: "Column 1" });
      dx.createColumn({ key: "col02", display: "Column 2", width: 150, position: 2, valueAlign: "right" });
      dx.createColumn({
          key: "col03", display: "Column 3", width: 100, type: "list", items: [
              { display: "Banana", value: "A" },
              { display: "Apple", value: "B" },
              { display: "Melon", value: "C" },
              { display: "Kiwi", value: "D" },
              { display: "Grape", value: "E" }
          ]
      });
      // 「creatColumn」メソッドは、「dx.addVirtualFile」メソッドと「dx.addVirtualFileList」メソッドの前に呼び出す必要があります。

  カスタム列はHTMLの単純なレベルで表現できるため、アイコンなどの画像を列の値として表示したり、ボタンを使用したりできます。

      dx.createColumn({
          key: "grade", display: "Grade", width: 80, itemAlign: "left", type: "list", items: [
              { display: "<img src='http://.../class_a.gif' /><span>A Grade</span>", value: "A" },
              { display: "<img src='http://.../class_b.gif' /><span>B Grade</span>", value: "B" },
              { display: "<img src='http://.../class_c.gif' /><span>C Grade</span>", value: "C" },
              { display: "<img src='http://.../class_d.gif' /><span>D Grade</span>", value: "D" },
              { display: "<img src='http://.../class_e.gif' /><span>E Grade</span>", value: "E" },
              { display: "<img src='http://.../class_f.gif' /><span>F Grade</span>", value: "F" },
              { display: "<img src='http://.../class_g.gif' /><span>G Grade</span>", value: "G" },
              { display: "<img src='http://.../class_h.gif' /><span>H Grade</span>", value: "H" },
              { display: "<img src='http://.../class_i.gif' /><span>I Grade</span>", value: "I" },
              { display: "<img src='http://.../class_j.gif' /><span>J Grade</span>", value: "J" }
          ]
      });

- 形式

      component.createColumn({ /* option */ });

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  key | String | これは、カスタム列の名前とメタデータの名前です。 キーはメタデータの名前として使用されるため、英語と数値の組み合わせのみを使用できます。 「name、size、op」という名前は使用できません。
  dispaly | String | これは、カスタム列のヘッダー名です。
  width | Number | カスタム列の幅。 デフォルトは50pxです。
  type | String | カスタム列を定義する方法として、「text」と「list」の2つの方法を選択できます。
  items | Array | カスタム列タイプが「リスト」のときに使用されるアイテムを示します。 「リスト」タイプは、コンポーネント画面のドロップダウンリストと同じ効果を表しません。 ただし、実際の値に一致するアイテムを選択する機能のみを提供します。 次の方法でitemsプロパティを設定します。
      dx.createColumn({
          key: "columnKey", display: "Column Name", width: 150, type: "list", items: [
              { display: "Banana", value: "A" },
              { display: "Apple", value: "B" },
              { display: "Melon", value: "C" },
              { display: "Kiwi", value: "D" },
              { display: "Grape", value: "E" }
          ]
      });
  position | Number | カスタム列が追加される場所を2から開始して示します。
  headerAlign | String | これは、ヘッダー名の水平方向の配置（「left」、「center」、「right」）を示します。 デフォルトは「center」です。
  itemAlign | String | これは、アイテムのコンテンツの水平方向の配置（「left」、「center」、「right」）を示します。 デフォルトは「center」です。

## deleteColumn

- 3.2.0.0以上

- 説明

  deleteColumnメソッドは、「GRID」スタイルコンポーネントからカスタム列を削除します。

      var dx = dx5.get(id);
      dx.deleteColumn("col1");
      dx.deleteColumn("col2");
      dx.deleteColumn("col3");

- 形式

      component.deleteColumn(key);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  key | String | これは、カスタム列の名前とメタデータの名前です。 キーはメタデータの名前として使用されるため、英語と数値の組み合わせのみを使用できます。 「name、size、op」という名前は使用できません。

## setColumnVisible

- 3.2.1.0以上

- 説明

  'GRID'スタイルコンポーネントの特定の列を表示および非表示にします。

      var dx = dx5.get(id);
      ...
      // 「size」列を非表示にします。
      dx.setColumnVisible("size", false);
      // 「size」列を表示します。
      dx.setColumnVisible("size", true);

- 形式

      component.setColumnVisible(key, visible);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  key | String | 表示または非表示にする列の名前（=key） サイズ列の名前は「size」で状態列の名前は「op」です。 「setColumnVisible」メソッドをファイル名の列に適用することはできません。
  visible | Boolean | 列を表示する場合はtrue、それ以外の場合はfalse。

## setEnableDeletionByKey

- 3.3.0.0以上

- 説明

  キーボードでアイテムを削除する機能のオン/オフを切り替えることができます。

      // アイテムが削除されないようにキーボードを設定します。
      dx.setEnableDeletionByKey(false);

- 形式

      component.setEnableDeletionByKey(byKey);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  byKey | Boolean | falseに設定すると、キーボードを使用してアイテムを削除できなくなります。 デフォルトはtrueです。

## setUploadByOrder

- 3.3.0.0以上

- 説明

  アップロード時に、画面に配置されたアイテムを順番にアップロードするように設定できます。 setUploadByOrderメソッドを使用しない場合、アップロードはファイルが追加された順序で続行されます。

      // アイテムを並べ替え順にアップロードするように設定します。
      dx.setUploadByOrder(true);

- 形式

      component.setUploadByOrder(byOrder);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  byOrder | Boolean | trueに設定すると、アップロードはソート順に実行されます。 デフォルトはfalseです。

## isChecksumEnable

- 3.4.0.0以上

- 説明

  整合性チェックのためにハッシュが生成されるかどうかを返します。

- 形式

      useChecksum = component.isChecksumEnable();

- リターンタ

  ハッシュを生成するかどうか、デフォルトはfalse

## setChecksumEnable

- 3.4.0.0以上

- 説明

  整合性チェック用のハッシュを生成するかどうかを設定します。 trueに設定すると、ファイルのアップロード時にファイルのハッシュがサーバーに送信されるため、サーバーはハッシュ情報と比較して整合性チェックを実行できます。

  DEXTUploadX5だけでは整合性チェックを実行できないため、サーバーコンポーネントとしてDEXTUploadNJバージョン2.6.0を使用する必要があります。 また、この機能は大きなファイルのアップロードにのみ適用されます（アップロードモードが「EXTS」の場合）。

      // 生成するハッシュをオンにします。
      dx.setChecksumEnable(true);

- 形式

      component.setChecksumEnable(enable);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  enable | Boolean | ハッシュを生成するかどうか

## setCustomFilter

- 3.5.0.0以上

- 説明

  カスタムフィルター機能を設定します。

  カスタムフィルターは、ユーザーが製品が提供する機能を使用せずにファイルアイテムを制限できる機能を定義できるようにする機能です。

      /**
       * ファイル名が拡張子名を除いて10桁を超える場合は拒否します。
       * @param file File（Blob）オブジェクト
       * @return trueの場合は許可し、拒否する場合はfalse。
       */
      function rejectFilesWithLongName(file) {
          if (file.name.length > 10) return false;
          else return true;
      }

      function onDX5Created(id) {
          var dx = dx5.get(id);
          ...
          // カスタムフィルター機能を登録します。
          dx.setCustomFilter(rejectFilesWithLongName);
      }

- 形式

      component.setCustomFilter(filter);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  filter | Function | ブール値を返すカスタムフィルター関数