Vue FileUploader Methods

The component's default device properties.

Object structure:

Name	Type	Description
device	Device \| Function	Device parameters. When you specify 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.

Name

Type

Description

device

Device

|

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

options

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, { Properties } from "devextreme/ui/file_uploader";
// ...
export class AppComponent {
    constructor () {
        FileUploader.defaultOptions<Properties>({
            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 dxFileUploader from "devextreme/ui/file_uploader";
import FileUploader from "devextreme-react/file-uploader";

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

export default function App() {
    return (
        <div>
            <FileUploader id="fileUploader1" />
            <FileUploader id="fileUploader2" />
        </div>
    )
}

You can also set rules for multiple device types:

jQuery

JavaScript

DevExpress.ui.dxFileUploader.defaultOptions({ 
    device: [
        { deviceType: 'desktop' },
        { deviceType: 'tablet' },
        { deviceType: 'phone' },
    ],
    options: {
        // Here go the FileUploader properties
    }
});

Angular

TypeScript

import FileUploader, { Properties } from "devextreme/ui/file_uploader";
// ...
export class AppComponent {
    constructor () {
        FileUploader.defaultOptions<Properties>({
            device: [
                { deviceType: 'desktop' },
                { deviceType: 'tablet' },
                { deviceType: 'phone' },
            ],
            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' },
        { deviceType: 'tablet' },
        { deviceType: 'phone' },
    ],
    options: {
        // Here go the FileUploader properties
    }
});

export default {
    components: {
        DxFileUploader
    }
}
</script>

React

import dxFileUploader from "devextreme/ui/file_uploader";
import FileUploader from "devextreme-react/file-uploader";

dxFileUploader.defaultOptions({
    device: [
        { deviceType: 'desktop' },
        { deviceType: 'tablet' },
        { deviceType: 'phone' },
    ],
    options: {
        // Here go the FileUploader properties
    }
});

export default function App() {
    return (
        <div>
            <FileUploader id="fileUploader1" />
            <FileUploader id="fileUploader2" />
        </div>
    )
}

dispose()

Disposes of all the resources allocated to the FileUploader instance.

jQuery

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

JavaScript

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

Angular

Use conditional rendering instead of this method:

app.component.html

<dx-file-uploader ...
    *ngIf="condition">
</dx-file-uploader>

Vue

Use conditional rendering instead of this method:

App.vue

<template>
    <DxFileUploader ...
        v-if="condition">
    </DxFileUploader>
</template>

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

export default {
    components: {
        DxFileUploader
    }
}
</script>

React

Use conditional rendering instead of this method:

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;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

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

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

endUpdate()

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

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

focus()

Sets focus on the UI component.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

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:

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);

instance()

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

Return Value:

This UI component's instance.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

jQuery

Handle Events

Angular

Event Handling

Vue

Event Handling

React

Event Handling

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

jQuery

Handle Events

Angular

Event Handling

Vue

Event Handling

React

Event Handling

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

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

jQuery

Handle Events

Angular

Event Handling

Vue

Event Handling

React

Event Handling

on(events)

Subscribes to events.

Parameters:

events:

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

Return Value:

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.

jQuery

Handle Events

Angular

Event Handling

Vue

Event Handling

React

Event Handling

option()

Gets all UI component properties.

Return Value:

The UI component's properties.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

option(optionName)

Gets the value of a single property.

Parameters:

optionName:

The property's name or full path.

Return Value: any

This property's value.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

option(optionName, optionValue)

Updates the value of a single property.

Parameters:

optionName:

The property's name or full path.

optionValue: any

This property's new value.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

option(options)

Updates the values of several properties.

Parameters:

options:

Options with their new values.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

registerKeyHandler(key, handler)

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

Parameters:

key:

A key.

handler:

A handler. Accepts the keydown event as the argument. It is a EventObject 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.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

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.

The method repaints Toolbar and re-initializes all its items.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

reset()

Resets the value property to the default value.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

resetOption(optionName)

Resets a property to its default value.

Parameters:

optionName: