FileUploader

The FileUploader widget enables an end user to upload files to the server. An end user can select files in the file explorer or drag and drop files to the FileUploader area on the page.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Export: default
FileUploader interactive configuration
Copy Code
Copy to Codepen
$("#fileuploader").dxFileUploader({
});

                    

The FileUploader widget is based on an <input> element with the type attribute set to "file". Values of widget options are passed to appropriate attributes of the underlying <input> element.

You can create the widget using one of the following approaches.

jQuery
JavaScript
HTML
$(function () {
    $("#fileUploader").dxFileUploader({
        accept: 'image/*'
    });
});
<div id="fileUploader"></div>
Angular
HTML
<dx-file-uploader accept="image/*"></dx-file-uploader>
AngularJS
HTML
<div dx-file-uploader="{
    accept: 'image/*'
}"></div>
Knockout
HTML
<div data-bind="dxFileUploader: {
    accept: 'image/*'
}"></div>
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().FileUploader()
    .ID("fileUploader")
    .Accept("image/*")
)
@(Html.DevExtreme().FileUploader() _
    .ID("fileUploader") _
    .Accept("image/*")
)

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.

View Demo Watch Video

See Also

Configuration

An object defining configuration options for the FileUploader widget.

Name Description
accept

Specifies a file type or several types accepted by the widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

allowCanceling

Specifies if an end user can remove a file from the selection and interrupt uploading.

disabled

Specifies whether the widget responds to user interaction.

elementAttr

Specifies the attributes to be attached to the widget's root element.

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

height

Specifies the widget's height.

hint

Specifies text for a hint that appears when a user pauses on the widget.

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

isValid

Specifies whether the editor's value is valid.

labelText

Specifies the text displayed on the area to which an end-user can drop a file.

multiple

Specifies whether the widget enables an end-user to select a single file or multiple files.

name

Specifies the value passed to the name attribute of the underlying input element.

onContentReady

A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

onDisposing

A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

onProgress

A handler for the uploaded event.

onUploadAborted

A handler for the uploadAborted event.

onUploaded

A handler for the uploaded event.

onUploadError

A handler for the uploadError event.

onUploadStarted

A handler for the uploadStarted event.

onValueChanged

A handler for the valueChanged event.

progress

Gets the current progress in percentages.

readOnly

A Boolean value specifying whether or not the widget is read-only.

readyToUploadMessage

The message displayed by the widget when it is ready to upload the specified files.

rtlEnabled

Switches the widget to a right-to-left representation.

selectButtonText

The text displayed on the button that opens the file browser.

showFileList

Specifies whether or not the widget displays the list of selected files.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

uploadButtonText

The text displayed on the button that starts uploading.

uploadedMessage

The message displayed by the widget when uploading is finished.

uploadFailedMessage

The message displayed by the widget on uploading failure.

uploadHeaders

Specifies headers for the upload request.

uploadMethod

Specifies the method for the upload request.

uploadMode

Specifies how the widget uploads files.

uploadUrl

Specifies a target Url for the upload request.

validationError

Holds the object that defines the error that occurred during validation.

value

Specifies a File instance representing the selected file. Read-only when uploadMode is "useForm".

visible

Specifies whether the widget is visible.

width

Specifies the widget's width.

Methods

This section describes the members used to manipulate the widget.

Name Description
beginUpdate()

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

defaultOptions(rule)

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

element()

Gets the root element of the widget.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

focus()

Sets focus on the widget.

instance()

Returns this widget's instance. Use it to access other methods of the widget.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Gets the widget's options.

option(optionName)

Gets a specific option value.

option(optionName, optionValue)

Assigns a new value to a specific option.

option(options)

Sets one or more options.

registerKeyHandler(key, handler)

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

repaint()

Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.

reset()

Resets the value option to the default value.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

initialized

Raised only once, after the widget is initialized.

optionChanged

Raised after an option of the widget is changed.

progress

Fires when a segment of a file has been uploaded.

uploadAborted

Fires when file uploading has been aborted.

uploaded

Fires when a file has been uploaded.

uploadError

Fires when an error has occurred during uploading.

uploadStarted

Fires when file uploading is started.

valueChanged

Fires when a file or several files are added to or removed from selection.

See Also