www.dextsolution.com
DEXTUPLOAD
X5
menu toggleReference > Events

onDX5DownloadBegin

  • Version 1.0.0.0 or later

  • Explanation

    The onDX5DownloadBegin function is a callback function that is called when the download begins.

    function onDX5DownloadBegin(id) {
    ...
    }

    An event occurs when performing multple-files-download. (This does not happen with single-file-download.)

  • Uses

    # Declare event handlers globally
    function onDX5DownloadBegin(id) { ... }
    
    # Register event handlers at component creation time (3.10.0.0 version or later)
    dx5.create({
        ...
        events: {
            downloadBegin: function(id) { ... }
        }
    });
    
  • Parameters

    Name Type Explanation
    id String The component id of the event

onDX5DownloadCompleted

  • Version 1.1.0.0 or later

  • Explanation

    The onDX5DownloadCompleted function is a callback function that is called when the download is complete.

    function onDX5DownloadCompleted(id) {
    ...
    }

    An event occurs when performing multi-files-download. (This does not happen with single-file-download.)

    Even if multiple-files-download is completed, there may be a step of saving the file itself (dialog display, temporary file copying, etc.) in the browser itself.

  • Uses

    # Declare event handlers globally
    function onDX5DownloadCompleted(id) { ... }
    
    # Register event handlers at component creation time (3.10.0.0 version or later)
    dx5.create({
        ...
        events: {
            downloadCompleted: function(id) { ... }
        }
    });
    
  • Parameters

    Name Type Explanation
    id String The component id of the event

onDX5DownloadItemEnd

  • Version 1.1.0.0 or later

  • Explanation

    The onDX5DownloadItemEnd function is a callback function that is called when the download is completed for each individual file.

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

    An event occurs when performing multi-files-download. (This does not happen with single-file-download.)

  • Uses

    # Declare event handlers globally
    function onDX5DownloadItemEnd(id, itemId) { ... }
    
    # Register event handlers at component creation time (3.10.0.0 version or later)
    dx5.create({
        ...
        events: {
            downloadItemEnd: function(id, itemId) { ... }
        }
    });
    
  • Parameters

    Name Type Explanation
    id String The component id of the event
    itemId String Unique ID of the item

onDX5DownloadItemStart

  • Version 1.1.0.0 or later

  • Explanation

    The onDX5DownloadItemStart function is a callback function that is called when the download starts for each individual file.

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

    An event occurs when performing multiple-files-download. (This does not happen with single-file-download.)

  • Uses

    # Declare event handlers globally
    function onDX5DownloadItemStart(id, itemId) { ... }
    
    # Register event handlers at component creation time (3.10.0.0 version or later)
    dx5.create({
        ...
        events: {
            downloadItemStart: function(id, itemId) { ... }
        }
    });
    
  • Parameters

    Name Type Explanation
    id String The component id of the event
    itemId String Unique ID of the item

onDX5DownloadStopped

  • Version 1.1.0.0 or later

  • Explanation

    The onDX5DownloadStopped function is a callback function that is called after the download has been forced to stop.

    function onDX5DownloadStopped(id) {
    ...
    }

    An event occurs when performing multiple-files-download. (This does not happen with single-file-download.)

  • Uses

    # Declare event handlers globally
    function onDX5DownloadStopped(id) { ... }
    
    # Register event handlers at component creation time (3.10.0.0 version or later)
    dx5.create({
        ...
        events: {
            downloadStopped: function(id) { ... }
        }
    });
    
  • Parameters

    Name Type Explanation
    id String The component id of the event