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

## addVirtualFile

- 1.0.0.0以上

- 説明

  仮想ファイルを登録する。

  仮想ファイルは、ユーザーのローカルPC上に存在せず、実体のない仮想のファイルをいう。一般的に、仮想ファイルは既にアップロードされたファイルに関する情報を残す目的で使用したりする。つまりサーバーに存在するファイルと呼ばれる表示として使用される。実際にローカルに存在しないファイルなので、ファイルのアップロード先ではない。

  仮想ファイルを登録するには、addVirtualFile関数を使用するかaddVirtualFileList関数を使用する。

      function onDX5Created(id) {
          // 仮想ファイルは、一般的にコンポーネントが作成された時点で登録をする。
          var dx = dx5.get(id);

          // 개별로 등록할 때
          dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
          dx.addVirtualFile({ vindex: "IDX0002", name: "locked-virtual_file.txt", size: 45678, lock: true });
          dx.addVirtualFile({ vindex: "IDX0003", name: "cosmos.jpg", size: 195779 });
          dx.addVirtualFile({ vindex: "IDX0004", name: "rose.jpg", size: 83560, meta: { type: "flower", color: "red" } });

          // 複数のを一度に登録するとき
          dx.addVirtualFileList([
              { vindex: "IDX0005", name: "virtual_file.txt", size: 12345 },
              { vindex: "IDX0006", name: "locked-virtual_file.txt", size: 45678, lock: true },
              { vindex: "IDX0007", name: "cosmos.jpg", size: 195779 }
          ]);
      }

  仮想ファイルが登録されるときonDX5BeforeItemsAdd、onDX5BeforeItemAdding、onDX5ItemsAddedコールバック関数を呼び出していない。

- 形式

      component.addVirtualFile(vf);

- パラメータ

  名前 | バージョン | 形式 | 説明
  --- | --- | --- | ---
  vindex |  | String | 仮想ファイルを区分する唯一のキーとして、どのような形式でも構いませんが、重複してはならない。
  name |  | String | 仮想ファイルの名前である。
  size |  | Number | ファイルのサイズ（バイト単位）である。
  lock |  | Boolean | 仮想ファイルがロックされているかどうかを設定する。 値がtrueの場合、削除がされない。
  middlePath |  | String | この属性は、フォルダ構造をダウンロードするために使用され、仮想ファイルが属するフォルダの名前です。 フォルダ構造をダウンロードするにはHDを使用します。
  url, downUrl, openUrl, thumbUrl, thumb |  | String | 仮想ファイルが指すWebアドレスである。相対パスを使用する場合は、ページパスを基準に解釈される。できるだけスキーマ（http、https）を含む完全なアドレスを設定することを推奨する。（4.4.0.0より前のバージョンでは、必ずスキーマを含む完全なアドレスを設定する必要がある。） ファイルをダウンロードするにはurl (1.4.1.0以降), downUrl属性を、ファイルを開くにはopenUrlを、ファイルをサムネイル化するにはthumbUrl (3.9.0.0以降), thumb属性を使用してください。
  checked | 1.3.2.0 | String | チェックされた状態であるかを設定する。 trueの場合、チェックがされた状態で登録される。
  eventUriStart(サポート終了) | 2.0.0.0以上、4.4.0.0未満 | String | HDアプリケーションを使用して、ファイルのダウンロードを利用する際に使用されるイベントのアドレスを設定する。 HDアプリケーションは、アイテムをダウンロードする際には、この属性が設定されている場合、ダウンロードを実行する前に、そのアドレスにGETリクエストを送信します。
  eventUriStop(サポート終了) | 2.0.0.0以上、4.4.0.0未満 | String | HDアプリケーションを使用して、ファイルのダウンロードを利用する際に使用されるイベントのアドレスを設定する。 HDアプリケーションは、アイテムをダウンロードする際には、この属性が設定されている場合、ダウンロードが停止すると、そのアドレスにGETリクエストを送信します。（エラーに起因する停止ではなく、ユーザーのアクションによる停止を意味する。）
  eventUriEnd(サポート終了) | 2.0.0.0以上、4.4.0.0未満 | String | HDアプリケーションを使用して、ファイルのダウンロードを利用する際に使用されるイベントのアドレスを設定する。 HDアプリケーションは、アイテムをダウンロードする際には、この属性が設定されている場合、ダウンロードが完了すると、そのアドレスにGETリクエストを送信します。
  chunkSize(サポート終了) | 2.0.0.0以上、4.4.0.0未満 | Number | HDアプリケーションを使用して、ファイルのダウンロードを利用する際、ファイルが分割されているサイズを設定する。 HDアプリケーションファイルをダウンロードするとき、要求にファイルを一度にダウンロードせずに、指定されたサイズだけ分けてダウンロードを実行する。ファイルを分けてダウンロードをすると、ファイルのダウンロード時間は、少し時間がかかることがありますが、サーバーをより安定的に運営することができる。ダウンロードするファイルのサイズが大きい場合は、そのファイルがダウンロード完了するまでの帯域幅を握っているので、性能上の問題が発生することができる。このような場合に、ファイルを分割すると、サーバーへのダウンロード要求が分けられるので、一部のユーザーがサーバーのリソースを長時間占有する現象が減ることになる。 指定がされていない場合は-1の値に設定がされており、-1または0の場合には、ファイルを分割せずに一つのリクエストである受ける。加えて、分割サイズは、MB単位でのみ指定しなければならない。
  hdTitle(サポート終了) | 2.1.2.0以上、4.4.0.0未満 | String | HDアプリケーションを使用して、ファイルのダウンロードを利用する際にウィンドウタイトルに出力されるテキストを示す。 ファイルがダウンロードされるとき、HDアプリケーションのウィンドウタイトル領域にテキストとファイル名が出力されるが、指定された値がない場合は、製品名とバージョンが出力される。
  meta | 3.2.0.0 | Object | 仮想ファイル登録時にメタデータを設定したい場合に使用する。このプロパティは、GRIDスタイルのカスタムカラム値として使用することができます。 例) meta: { type: "A", color: "B" }

## addVirtualFileList

- 1.0.0.0以上

- 説明

  配列を使用して、一度に仮想ファイルを登録する。

      function onDX5Created(id) {
        // 仮想ファイルは、一般的にコンポーネントが作成された時点で登録をする。
        var dx = dx5.get(id);
        dx.addVirtualFileList([
          { vindex: "IDX0004", name: "virtual_file.txt", size: 12345 },
          { vindex: "IDX0005", name: "locked-virtual_file.txt", size: 45678, lock: true },
          { vindex: "IDX0006", name: "cosmos.jpg", size: 195779 }
        ]);
      }

  仮想ファイルが登録されるときonDX5BeforeItemsAdd、onDX5BeforeItemAdding、onDX5ItemsAddedコールバック関数を呼び出していない。

- 形式

      component.addVirtualFileList(vfs);

- パラメータ

  名前 | サポート | 形式 | 説明
  --- | --- | --- | ---
  vfs | Array | 登録する仮想ファイル情報を持つjsonオブジェクトの配列、addVirtualFileメソッドを参照すること。

## openFileDialog

- 1.0.0.0以上

- 説明

  アップロードするファイルを追加するためのファイル選択ダイアログウィンドウを表示し。

  DEXTUploadX5は、コンポーネント自体にファイルを追加するボタンやGUI要素がない。

  代わりに、スクリプトを使用してファイルを追加することができるように関数を提供している。

  ファイル選択ダイアログウィンドウで選択したターゲットがある場合はウィンドウを閉じた後、trueの値を返します。

      <button type="button" onclick="addFiles();">ボタン</button>
      <script>
      function addFiles() {
        var dx = dx5.get("component-id");
        dx.openFileDialog();
      }
      </script>

  openFileDialog関数の戻り値を処理するコードがない場合は、コンポーネントの作成時にbtnFile属性値を使用して自動的にバインドして使用することができる。

      <button id="btn-add-files" type="button">ボタン</button>
      <script>
        dx5.create({
          ...,
          // ファイルの追加機能が自動的に接続される。
          btnFile: "btn-add-files"
        });
      </script>

- 形式

      component.openFileDialog();

## openFolderDialog

- 3.6.0.0以上

- 説明

  フォルダー ダイアログ ウィンドウを開いて、アップロードするファイルとフォルダーを追加します。

  DEXTUploadX5 には、コンポーネント自体にフォルダーを追加するためのボタンや GUI 要素はありません。 代わりに、スクリプトを使用してフォルダーを追加できる機能を提供します。

      <button type="button" onclick="addFolder();">ボタン</button>
      <script>
      function addFolder() {
          var dx = dx5.get("component-id");
          dx.openFolderDialog();
      }
      </script>

  コンポーネントの作成時に「btnFolder」プロパティを使用して、ボタンに自動的にバインドできます。

      <button id="btn-add-folder" type="button">ボタン</button>
      <script>
          dx5.create({
              ...,
              // フォルダの追加機能が自動的に接続される。
              btnFolder: "btn-add-folder"
          });
      </script>

- 形式

      component.openFolderDialog();