A newer version of this page is available. Switch to the current version.

Methods

This section describes methods that manage the FileUploader UI component.

abortUpload()

Cancels the file upload.

jQuery
JavaScript
var uploadControl = $("#uploaderContainer").dxFileUploader("instance");

uploadControl.abortUpload()
NOTE

The abortUpload method works differently in the following upload modes:

  • useForm: The method is not supported in this mode.

  • useButtons: Cancels the file upload and makes the file available for upload.

  • instantly: Cancels the file upload.

abortUpload(file)

Cancels the file upload.

Parameters:
file:

File

The file for which the upload is cancelled.

jQuery
JavaScript
var uploadControl = $("#uploaderContainer").dxFileUploader("instance");

uploadControl.abortUpload(uploader.option('value[1]'))
NOTE

The abortUpload method works differently in the following upload modes:

  • useForm: The method is not supported in this mode.

  • useButtons: Cancels the file upload and makes the file available for upload.

  • instantly: Cancels the file upload.

abortUpload(fileIndex)

Cancels the file upload.

Parameters:
fileIndex:

Number

The index of the file for which the upload is cancelled.

jQuery
JavaScript
var uploadControl = $("#uploaderContainer").dxFileUploader("instance");

uploadControl.abortUpload(1)
NOTE

The abortUpload method works differently in the following upload modes:

  • useForm: The method is not supported in this mode.

  • useButtons: Cancels the file upload and makes the file available for upload.

  • instantly: Cancels the file upload.

beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.

See Also

defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.

Parameters:
rule:

Object

The component's default device properties.

Object structure:
Name Type Description
device

Device

|

Array<Device>

|

Function

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

options

Object

Options to be applied.

defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the FileUploader UI component in an application executed on the desktop.

jQuery
JavaScript
DevExpress.ui.dxFileUploader.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the FileUploader properties
    }
});
Angular
TypeScript
import FileUploader from "devextreme/ui/file_uploader";
// ...
export class AppComponent {
    constructor () {
        FileUploader.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the FileUploader properties
            }
        });
    }
}
Vue
<template>
    <div>
        <DxFileUploader id="fileUploader1" />
        <DxFileUploader id="fileUploader2" />
    </div>
</template>
<script>
import DxFileUploader from "devextreme-vue/file-uploader";
import FileUploader from "devextreme/ui/file_uploader";

FileUploader.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the FileUploader properties
    }
});

export default {
    components: {
        DxFileUploader
    }
}
</script>
React
import React from "react";
import dxFileUploader from "devextreme/ui/file_uploader";
import FileUploader from "devextreme-react/file-uploader";

class App extends React.Component {
    render () {
        dxFileUploader.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the FileUploader properties
            }
        })
        return (
            <div>
                <FileUploader id="fileUploader1" />
                <FileUploader id="fileUploader2" />
            </div>
        )
    }
}

export default App;

dispose()

Disposes of all the resources allocated to the FileUploader instance.

After calling this method, remove the DOM element associated with the UI component:

JavaScript
$("#myFileUploader").dxFileUploader("dispose");
$("#myFileUploader").remove();

Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular
app.component.html
<dx-file-uploader ...
    *ngIf="condition">
</dx-file-uploader>
Vue
App.vue
<template>
    <DxFileUploader ...
        v-if="condition">
    </DxFileUploader>
</template>

<script>
import DxFileUploader from 'devextreme-vue/file-uploader';

export default {
    components: {
        DxFileUploader
    }
}
</script>
React
App.js
import React from 'react';

import FileUploader from 'devextreme-react/file-uploader';

function DxFileUploader(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <FileUploader ... >    
        </FileUploader>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxFileUploader shouldRender="condition" />
        );
    }
}
export default App;
See Also

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

focus()

Sets focus on the UI component.

See Also

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:
element:

Element

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the FileUploader instance found in an element with the myFileUploader ID:

// Modular approach
import FileUploader from "devextreme/ui/file_uploader";
...
let element = document.getElementById("myFileUploader");
let instance = FileUploader.getInstance(element) as FileUploader;

// Non-modular approach
let element = document.getElementById("myFileUploader");
let instance = DevExpress.ui.dxFileUploader.getInstance(element);
See Also

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

Return Value:

FileUploader

This UI component's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

FileUploader

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

FileUploader

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

FileUploader

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

FileUploader

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Return Value:

Object

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Options with their new values.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:
key:

String

A key.

handler:

Function

A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.

The key argument accepts one of the following values:

  • "backspace"
  • "tab"
  • "enter"
  • "escape"
  • "pageUp"
  • "pageDown"
  • "end"
  • "home"
  • "leftArrow"
  • "upArrow"
  • "rightArrow"
  • "downArrow"
  • "del"
  • "space"
  • "F"
  • "A"
  • "asterisk"
  • "minus"

A custom handler for a key cancels the default handler for this key.

See Also

removeFile(file)

Removes a file.

Parameters:
file:

File

The file that is being removed.

NOTE
The removeFile method is not supported in useForm upload mode.

removeFile(fileIndex)

Removes a file with the specified index.

Parameters:
fileIndex:

Number

The file's index.

jQuery
JavaScript
var uploadControl = $("#uploaderContainer").dxFileUploader("instance");

uploadControl.removeFile(1)
NOTE
The removeFile method is not supported in useForm upload mode.

repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.

See Also

reset()

Resets the value property to the default value.

See Also

resetOption(optionName)

Resets an property to its default value.

Parameters:
optionName:

String

An property's name.

See Also

upload()

Uploads all the selected files.

jQuery
JavaScript
var uploadControl = $("#file-uploader").dxFileUploader("instance");

uploadControl.upload();
NOTE
The upload method is not supported in useForm upload mode. In instantly upload mode, the upload method is useful if you use the value property to select a file(s) you want to upload.

upload(file)

Uploads the specified file.

Parameters:
file:

File

The file that is being uploaded.

jQuery
JavaScript
var uploadControl = $("#file-uploader").dxFileUploader("instance");

uploadControl.upload(uploader.option('value[1]'));
NOTE
The upload method is not supported in useForm upload mode. In instantly upload mode, the upload method is useful if you use the value property to select a file(s) you want to upload.

upload(fileIndex)

Uploads a file with the specified index.

Parameters:
fileIndex:

Number

The file's index.

jQuery
JavaScript
var uploadControl = $("#file-uploader").dxFileUploader("instance");

uploadControl.upload(1);
NOTE
The upload method is not supported in useForm upload mode. In instantly upload mode, the upload method is useful if you use the value property to select a file(s) you want to upload.