www.dextsolution.com
DEXTUPLOAD
X5
リファレンス > イベント

## onDX5Created

- 1.0.0.0以上

- 説明

  onDX5Created関数は、コンポーネントが作成されると呼び出されるコールバック関数である。

  DEXTUploadX5は、DOMのonloadイベントを持って生成サイクルを判断することができないので、コンポーネントが作成されたときonDX5Createdコールバック関数を呼び出すようになっている。

      function onDX5Created(id) {
          // アップロードパスの設定
          // スタイルの設定
          // 仮想ファイル登録
      }

- 形式

      # グローバルでイベントハンドラを宣言
      function onDX5Created(id) { ... }

      # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
      dx5.create({
          ...
          events: {
              created: function(id) { ... }
          }
      });

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | イベントが発生したコンポーネントのID

## onDX5Error

- 1.0.0.0以上

- 説明

  onDX5Error関数は、コンポーネントの内部でエラーが発生した場合に呼び出されるコールバック関数である。

  HTTPは、GET、POSTリクエスト（ファイルのアップロードも同様）をしたときに、サーバーから問題なくコードが完了された場合、HTTPステータスコードの値200が返される。DEXTUploadX5は、サーバーから200コード値を受け取ると、ファイルのアップロードが完了したこと知るされ、この時onDX5UploadCompletedコールバック関数を呼び出します。この一方で、サーバーから400、403、404、500のようなHTTPステータスコードを受信する場合は、エラーが発生したと判断して、追加の作業を停止し、onDX5Errorコールバック関数を呼び出します。したがって、サーバー側のコードでは、エラーが発生したとき、これを無視するか、他の形式でパッケージしてはならず、Exceptionが発生した場合、500エラーが配信になるように措置をしなければならない。もしtry - catch構文のようにサーバーでエラーをキャッチして、エラーを渡さない場合、サーバーは200の値を返すことになるので、DEXTUploadX5はアップロードが正常に完了したと判断することになる。

      function onDX5Error(id, code, message) {
          alert(code + "\n" + message);
      }

  もしonDX5Error関数がページ内にない場合は、発生したエラーを確認する方法がない。DEXTUploadX5はonDX5Error関数のほかのエラーを別々に記録するログ記録機能はない。

- 形式

      # グローバルでイベントハンドラを宣言
      function onDX5Error(id, code, message) { ... }

      # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
      dx5.create({
          ...
          events: {
              error: function(id, code, message) { ... }
          }
      });

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | イベントが発生したコンポーネントのID
  code | String | エラーコード
  message | String | エラーメッセージ

## onDX5ItemDoubleClick

- 1.0.0.0以上

- 説明

  onDX5ItemDoubleClick関数は、マウスを使用して項目をダブルクリックをすると呼び出されるコールバック関数である。

      function onDX5ItemDoubleClick(id, itemIndex, itemId, itemType) {
          ...
      }

- 形式

      # グローバルでイベントハンドラを宣言
      function onDX5ItemDoubleClick(id, itemIndex, itemId, itemType) { ... }

      # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
      dx5.create({
          ...
          events: {
              itemDoubleClick: function(id, itemIndex, itemId, itemType) { ... }
          }
      });

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | イベントが発生したコンポーネントのID
  itemIndex | Number | 項目の順序
  itemId | String | 項目の一意のID
  itemType | String | 項目の形式（「FILE」、「FOLDER "、" VIRTUAL "）

## onDX5ItemSelect

- 1.0.0.0以上

- 説明

  onDX5ItemSelect関数は、項目が選択状態になると呼び出されるコールバック関数である。

  選択イベントは、マウスクリックやキーボードの移動過​​程に発生する。

      function onDX5ItemSelect(id, itemIndex, itemId, itemType) {
          ...
      }

- 形式

      # グローバルでイベントハンドラを宣言
      function onDX5ItemSelect(id, itemIndex, itemId, itemType) { ... }

      # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
      dx5.create({
          ...
          events: {
              itemSelect: function(id, itemIndex, itemId, itemType) { ... }
          }
      });

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | イベントが発生したコンポーネントのID
  itemIndex | Number | 項目の順序
  itemId | String | 項目の一意のID
  itemType | String | 項目の形式（「FILE」、「FOLDER "、" VIRTUAL "）

## onDX5ItemCheck

- 1.0.0.0以上

- 説明

  onDX5ItemCheck関数は、アイテムがチェックされたとき、またはチェックが外されたときに呼び出されるコールバック関数です。

      function onDX5ItemCheck(id, count) {
          ...
      }

- 形式

      # グローバルでイベントハンドラを宣言
      function onDX5ItemCheck(id, count) { ... }

      # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
      dx5.create({
          ...
          events: {
              itemCheck: function(id, count) { ... }
          }
      });

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | イベントが発生したコンポーネントID
  count | Number | チェックされた項目の数

## onDX5Preview

- 1.0.0.0以上

- 説明

  onDX5Preview関数は、プレビューがイベントで設定されると呼び出されるコールバック関数である。

      function onDX5Preview(id, itemIndex, itemId, itemSource) {
          target.src = itemSource;
      }

- 形式

      # グローバルでイベントハンドラを宣言
      function onDX5Preview(id, itemIndex, itemId, itemSource) { ... }

      # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
      dx5.create({
          ...
          events: {
              preview: function(id, itemIndex, itemId, itemSource) { ... }
          }
      });

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | イベントが発生したコンポーネントのID
  itemIndex | Number | 項目の順序
  itemId | String | 項目の一意のID
  itemSource | String | イメージソース（データURLまたはローカルイメージパス）

## onDX5ItemsToHDFinish

- 3.6.0.0以上

- 説明

  onDX5ItemsToHDFinish 関数は、HD アプリにダウンロードするリストの追加が完了したときに呼び出されるコールバック関数です。

      function onDX5ItemsToHDFinish(id, arr) {
          console.log("Transferring items was finished");
      }

  onDX5ItemsToHDFinish が呼び出される前に、HD アプリケーションはすでにファイルのダウンロードを開始しています。

- 形式

      # グローバルでイベントハンドラを宣言
      function onDX5ItemsToHDFinish(id, arr) { ... }

      # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
      dx5.create({
          ...
          events: {
              itemsToHDFinish: function(id, arr) { ... }
          }
      });

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | イベントが発生したコンポーネントのID
  arr | Array | ダウンロードするファイルを含む配列