JavaScript/jQuery FileUploader Options
An object defining configuration options for the FileUploader widget.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
abortUpload
A function that cancels the file upload.
The file that is uploaded.
Information about the file upload session.
Name | Type | Description |
---|---|---|
bytesUploaded |
The count of bytes that is already uploaded to the server. |
|
chunkBlob |
The binary content of the chunk that is uploaded. |
|
chunkCount |
The number of all chunks. |
|
chunkIndex |
The index of the chunk that is uploaded. |
|
customData |
Any custom information that is saved during upload. |
A Promise that is resolved after the upload in aborted. It is a native Promise or a jQuery.Promise when you use jQuery.
jQuery
$(function() { $("#file-uploader").dxFileUploader({ multiple: true, chunkSize: 200000, abortUpload: function(file, uploadInfo) { // your code } }); });
accept
Specifies a file type or several types accepted by the widget.
The value of this option is passed to the accept attribute of the underlying input element. Thus, the option accepts a MIME type or several types separated by a comma. Refer to the input element documentation for information on available values.
accessKey
Specifies the shortcut key that sets focus on the widget.
The value of this option will be passed to the accesskey
attribute of the HTML element that underlies the widget.
activeStateEnabled
Specifies whether or not the widget changes its state when interacting with a user.
This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.
allowCanceling
Specifies if an end user can remove a file from the selection and interrupt uploading.
If this option is set to true, a cancel button is displayed for each selected file.
chunkSize
Specifies the chunk size in bytes. Applies only if uploadMode is "instantly" or "useButtons". Requires a server that can process file chunks.
Set this option to a positive value to enable chunk upload. The widget should be configured as described in the Chunk Upload article. When chunk upload is enabled, the FileUploader sends several multipart/form-data requests with information about the file and chunk. The "chunkMetadata" parameter contains chunk details as a JSON object of the following structure:
{ "FileGuid": string, "FileName": string, "FileType": string, "FileSize": long, "Index": long, // The chunk's index "TotalCount": long, // The file's total chunk count }
See Also
elementAttr
Specifies the attributes to be attached to the widget's root element.
jQuery
$(function(){ $("#fileUploaderContainer").dxFileUploader({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-file-uploader ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-file-uploader>
import { DxFileUploaderModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxFileUploaderModule ], // ... })
Vue
<template> <DxFileUploader ... :element-attr="fileUploaderAttributes"> </DxFileUploader> </template> <script> import DxFileUploader from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, data() { return { fileUploaderAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import FileUploader from 'devextreme-react/file-uploader'; class App extends React.Component { fileUploaderAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <FileUploader ... elementAttr={this.fileUploaderAttributes}> </FileUploader> ); } } export default App;
focusStateEnabled
Specifies whether the widget can be focused using keyboard navigation.
height
Specifies the widget's height.
This option accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
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.
inputAttr
Specifies the attributes to be passed on to the underlying <input>
element of the file
type.
jQuery
$(function(){ $("#fileUploaderContainer").dxFileUploader({ // ... inputAttr: { id: "inputId" } }); });
Angular
<dx-file-uploader ... [inputAttr]="{ id: 'inputId' }"> </dx-file-uploader>
import { DxFileUploaderModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxFileUploaderModule ], // ... })
ASP.NET MVC Controls
@(Html.DevExtreme().FileUploader() .InputAttr("id", "inputId") // ===== or ===== .InputAttr(new { @id = "inputId" }) // ===== or ===== .InputAttr(new Dictionary<string, object>() { { "id", "inputId" } }) )
@(Html.DevExtreme().FileUploader() _ .InputAttr("id", "inputId") ' ===== or ===== .InputAttr(New With { .id = "inputId" }) ' ===== or ===== .InputAttr(New Dictionary(Of String, Object) From { { "id", "inputId" } }) )
invalidFileExtensionMessage
The text displayed when the extension of the file being uploaded is not an allowed file extension.
invalidMaxFileSizeMessage
The text displayed when the size of the file being uploaded is greater than the maxFileSize.
invalidMinFileSizeMessage
The text displayed when the size of the file being uploaded is less than the minFileSize.
isValid
Specifies or indicates whether the editor's value is valid.
The FileUploader provides alternative validation options: maxFileSize, minFileSize, and allowedFileExtensions.
labelText
Specifies the text displayed on the area to which an end-user can drop a file.
maxFileSize
Specifies the maximum file size (in bytes) allowed for uploading. Applies only if uploadMode is "instantly" or "useButtons".
minFileSize
Specifies the minimum file size (in bytes) allowed for uploading. Applies only if uploadMode is "instantly" or "useButtons".
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. Required to access uploaded files on the server.
See Also
onContentReady
A function that is executed when the widget's content is ready and each time the content is changed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only when using Knockout. |
onDisposing
A function that is executed before the widget is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onInitialized
A function used in JavaScript frameworks to save the widget instance.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
A function that is executed after a widget option is changed.
Information about the event.
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified option that includes all parent options. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
name |
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into. |
|
value | any |
The modified option's new value. |
onProgress
A function that is executed when a file segment is uploaded.
Information about the event.
Name | Type | Description |
---|---|---|
bytesLoaded |
The total count of the uploaded bytes. |
|
bytesTotal |
The total count of bytes in the XMLHttpRequest. |
|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
file |
An uploaded file. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
|
request |
An XMLHttpRequest for the file. |
|
segmentSize |
The size of the uploaded file segment. |
onUploadAborted
A function that is executed when the file upload is aborted.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
file |
The uploaded file. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
|
request |
Specifies an XMLHttpRequest for the file. |
onUploaded
A function that is executed when a file is successfully uploaded.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
file |
The uploaded file. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
|
request |
Specifies an XMLHttpRequest for the file. |
onUploadError
A function that is executed when an error occurs during the file upload.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
error | any |
The error that occurred. |
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
file |
The uploaded file. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
|
request |
Specifies an XMLHttpRequest for the file. |
The following code shows how you can handle a network error.
jQuery
$(function(){ $("#fileUploader").dxFileUploader({ // ... onUploadError: function(e){ var xhttp = e.request; if (xhttp.readyState == 4 && xhttp.status == 0) { console.log("Connection refused."); } } }); });
Angular
export class AppComponent { handleNetworkError (e) { var xhttp = e.request; if (xhttp.readyState == 4 && xhttp.status == 0) { console.log("Connection refused."); } } }
<dx-file-uploader ... (onUploadError)="handleNetworkError($event)"> </dx-fileUploader>
onUploadStarted
A function that is executed when the file upload is started.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
file |
The uploaded file. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
|
request |
Specifies an XMLHttpRequest for the file. |
onValueChanged
A function that is executed when one or several files are added to or removed from the selection.
Information about the event.
Name | Type | Description |
---|---|---|
value |
Newly selected files. |
|
previousValue |
Previously selected files. |
|
model |
Model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically. |
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
readyToUploadMessage
The message displayed by the widget when it is ready to upload the specified files.
This option makes sense only if the uploadMode option is set to "useButtons".
rtlEnabled
Switches the widget to a right-to-left representation.
When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
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.
The value of this option will be passed to the tabindex
attribute of the HTML element that underlies the widget.
uploadButtonText
The text displayed on the button that starts uploading.
The option makes sense only if the uploadMode option is set to "useButtons" or "instantly".
uploadChunk
A function that uploads a file in chunks.
The file that is uploaded.
Information about the file upload session.
Name | Type | Description |
---|---|---|
bytesUploaded |
The count of bytes that is already uploaded to the server. |
|
chunkBlob |
The binary content of the chunk that is uploaded. |
|
chunkCount |
The number of all chunks. |
|
chunkIndex |
The index of the chunk that is uploaded. |
|
customData |
Any custom information that is saved during the upload. |
A Promise that is resolved after the chunk is uploaded. It is a native Promise or a jQuery.Promise when you use jQuery.
jQuery
$(function() { $("#file-uploader").dxFileUploader({ multiple: true, chunkSize: 200000, uploadChunk: function(file, uploadInfo) { // your code } }); });
uploadedMessage
The message displayed by the widget when uploading is finished.
The option makes sense only if the uploadMode option is set to "useButtons" or "instantly".
uploadFailedMessage
The message displayed by the widget on uploading failure.
The option makes sense only if the uploadMode option is set to "useButtons" or "instantly".
uploadFile
A function that uploads a file.
A Promise that is resolved after the file is uploaded. It is a native Promise or a jQuery.Promise when you use jQuery.
A Promise that is resolved after the file is uploaded. It is a native Promise or a jQuery.Promise when you use jQuery.
jQuery
$(function() { $("#file-uploader").dxFileUploader({ multiple: true, uploadFile: function(file, progressCallback) { // your code progressCallback(100); // ... progressCallback(200); // ... } }); });
uploadMethod
Specifies the method for the upload request.
The option makes sense only if the uploadMode option is set to "useButtons" or "instantly".
Use the UploadHttpMethod
enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: POST
and PUT
.
uploadMode
Specifies how the widget uploads files.
Depending on the uploadMode, the FileUploader widget uses an HTML form or a FormData interface with a series of Ajax requests to upload files. The uploadMode option accepts one of the following values:
"instantly" (default)
Ajax upload. Files are uploaded after they are selected."useButtons"
Ajax upload. Files are uploaded after a user clicks the Upload button."useForm"
HTML form upload. Files are uploaded when the HTML form is submitted.
Use the FileUploadMode
enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Instantly
, UseButtons
, and UseForm
.
See Also
uploadUrl
Specifies a target Url for the upload request.
The option makes sense only if the uploadMode option is set to "useButtons" or "instantly".
validationError
Information on the broken validation rule. Contains the first item from the validationErrors array.
See Also
validationStatus
Indicates or specifies the current validation status.
The following table illustrates the validation status indicators:
validationStatus | Indicator |
---|---|
"pending" |
![]() |
"valid" |
![]() |
"invalid" |
![]() |
value
Specifies a File instance representing the selected file. Read-only when uploadMode is "useForm".
width
Specifies the widget's width.
This option accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.