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

onDX5DownloadBegin

  • 1.0.0.0以上

  • 説明

    onDX5DownloadBegin関数は、ダウンロードが開始されると呼び出されるコールバック関数である。

    function onDX5DownloadBegin(id) {
    ...
    }

    複数のファイルのダウンロードを実行するときに、イベントが発生する。(単一ファイルのダウンロードでは発生しない。)

  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5DownloadBegin(id) { ... }
    
    # コンポーネント生成時点でイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            downloadBegin: function(id) { ... }
        }
    });
    
  • パラメータ

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

onDX5DownloadCompleted

  • 1.1.0.0以上

  • 説明

    onDX5DownloadCompleted関数は、ダウンロードが完了したときに呼び出されるコールバック関数である。

    function onDX5DownloadCompleted(id) {
    ...
    }

    複数のファイルのダウンロードを実行するときに、イベントが発生する。(単一ファイルのダウンロードでは発生しない。)

    複数ファイルのダウンロードが完了しても、ブラウザ自体でファイルを保存する(ダイアログの表示、一時ファイルのコピーなど)段階がある場合があります。

  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5DownloadCompleted(id) { ... }
    
    # コンポーネント生成時点でイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            downloadCompleted: function(id) { ... }
        }
    });
    
  • パラメータ

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

onDX5DownloadItemEnd

  • 1.1.0.0以上

  • 説明

    onDX5DownloadItemEnd関数は、個々のファイルごとにダウンロードが完了したときに呼び出されるコールバック関数である。

    function onDX5DownloadItemEnd(id, itemId) {
    ...
    }

    複数のファイルのダウンロードを実行するときに、イベントが発生する。(単一ファイルのダウンロードでは発生しない。)

  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5DownloadItemEnd(id, itemId) { ... }
    
    # コンポーネント生成時点でイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            downloadItemEnd: function(id, itemId) { ... }
        }
    });
    
  • パラメータ

    名前 形式 説明
    id String イベントが発生したコンポーネントのID
    itemId String 項目の一意のID

onDX5DownloadItemStart

  • 1.1.0.0以上

  • 説明

    onDX5DownloadItemStart関数は、個々のファイルごとにダウンロードが開始されると呼び出されるコールバック関数である。

    function onDX5DownloadItemStart(id, itemId) {
    ...
    }

    複数のファイルのダウンロードを実行するときに、イベントが発生する。(単一ファイルのダウンロードでは発生しない。)

  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5DownloadItemStart(id, itemId) { ... }
    
    # コンポーネント生成時点でイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            downloadItemStart: function(id, itemId) { ... }
        }
    });
    
  • パラメータ

    名前 形式 説明
    id String イベントが発生したコンポーネントのID
    itemId String 項目の一意のID

onDX5DownloadStopped

  • 1.1.0.0以上

  • 説明

    onDX5DownloadStopped関数はダウンロードが強制的に停止された後に呼び出されるコールバック関数である。

    function onDX5DownloadStopped(id) {
    ...
    }

    複数のファイルのダウンロードを実行するときに、イベントが発生する。(単一ファイルのダウンロードでは発生しない。)

  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5DownloadStopped(id) { ... }
    
    # コンポーネント生成時点でイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            downloadStopped: function(id) { ... }
        }
    });
    
  • パラメータ

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