React FileUploader Props
See Also
abortUpload
A Promise that is resolved after the upload is aborted. It is a native Promise or a jQuery.Promise when you use jQuery.
jQuery
$(function() { $("#file-uploader").dxFileUploader({ abortUpload: function(file, uploadInfo) { // your code } }); });
Angular
<dx-file-uploader ... [abortUpload]="fileUploader_abortUpload"> </dx-file-uploader>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // Uncomment the following lines if the function should be executed in the component's context // constructor() { // this.fileUploader_abortUpload = this.fileUploader_abortUpload.bind(this); // } fileUploader_abortUpload(file, uploadInfo) { // ... } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFileUploaderModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFileUploaderModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxFileUploader ... :abort-upload="fileUploader_abortUpload" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxFileUploader from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, methods: { fileUploader_abortUpload(file, uploadInfo) { // ... } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import FileUploader from 'devextreme-react/file-uploader'; class App extends React.Component { // Uncomment the following lines if the function should be executed in the component's context // constructor(props) { // super(props); // this.fileUploader_abortUpload = this.fileUploader_abortUpload.bind(this); // } fileUploader_abortUpload(file, uploadInfo) { // ... } render() { return ( <FileUploader ... abortUpload={this.fileUploader_abortUpload} /> ); } } export default App;
ASP.NET Core Controls
@(Html.DevExtreme().FileUploader() @* ... *@ .AbortUpload("abortUpload") ) <script type="text/javascript"> function abortUpload(file, uploadInfo) { // ... } </script>
ASP.NET MVC Controls
@(Html.DevExtreme().FileUploader() @* ... *@ .AbortUpload("abortUpload") ) <script type="text/javascript"> function abortUpload(file, uploadInfo) { // ... } </script>
accept
The value of this property is passed to the accept attribute of the underlying input element. Thus, the property accepts a MIME type or several types separated by a comma. Refer to the input element documentation for information on available values.
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.
Use this property when you display the component on a platform whose guidelines include the active state change for UI components.
allowCanceling
If this property 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 property to a positive value to enable chunk upload. The UI component 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
dialogTrigger
This property accepts one of the following values:
A CSS selector, or a jQuery selector if you use jQuery
jQuery
index.js$(function(){ $("#fileUploaderContainer").dxFileUploader({ // ... dialogTrigger: '.open-button' }); });
Angular
app.component.html<dx-file-uploader ... dialogTrigger=".open-button" > </dx-file-uploader>
Vue
App.vue<template> <DxFileUploader ... dialog-trigger=".open-button" > </DxFileUploader> </template> <script> import { DxFileUploader } from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader } }; </script>
React
App.jsimport FileUploader from 'devextreme-react/file-uploader'; // ... function App() { return ( <FileUploader ... dialogTrigger=".open-button" > </FileUploader> ); }
A jQuery wrapper
jQuery
index.js$(function(){ $("#fileUploaderContainer").dxFileUploader({ // ... dialogTrigger: $('.open-button') }); });
A DOM element
jQuery
index.js$(function(){ $("#fileUploaderContainer").dxFileUploader({ // ... dialogTrigger: document.querySelector('.open-button') }); });
Angular
app.component.htmlapp.component.ts<dx-file-uploader ... [dialogTrigger]="targetElement" > </dx-file-uploader>
// ... export class AppComponent { targetElement: Element; constructor() { this.targetElement = document.querySelector('.open-button') as Element; } }
Vue
App.vue<template> <DxFileUploader ... :dialog-trigger="targetElement" > </DxFileUploader> </template> <script> import { DxFileUploader } from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, data() { return { targetElement: null } }, mounted() { this.targetElement = document.querySelector('.open-button'); } }; </script>
React
App.jsimport React, { useEffect, useState } from 'react'; import FileUploader from 'devextreme-react/file-uploader'; // ... function App() { const [targetElement, setTargetElement] = useState(null); useEffect(() => { setTargetElement(document.querySelector('.open-button')); }, []); return ( <FileUploader ... dialogTrigger={targetElement} > </FileUploader> ); }
dropZone
This property accepts one of the following values:
A CSS selector, or a jQuery selector if you use jQuery
jQuery
index.js$(function(){ $("#fileUploaderContainer").dxFileUploader({ // ... dropZone: '.test-div' }); });
Angular
app.component.html<dx-file-uploader ... dropZone=".test-div" > </dx-file-uploader>
Vue
App.vue<template> <DxFileUploader ... drop-zone=".test-div" > </DxFileUploader> </template> <script> import { DxFileUploader } from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader } }; </script>
React
App.jsimport FileUploader from 'devextreme-react/file-uploader'; // ... function App() { return ( <FileUploader ... dropZone=".test-div" > </FileUploader> ); }
A jQuery wrapper
jQuery
index.js$(function(){ $("#fileUploaderContainer").dxFileUploader({ // ... dropZone: $('.test-div') }); });
A DOM element
jQuery
index.js$(function(){ $("#fileUploaderContainer").dxFileUploader({ // ... dropZone: document.querySelector('.test-div') }); });
Angular
app.component.htmlapp.component.ts<dx-file-uploader ... [dropZone]="targetElement" > </dx-file-uploader>
// ... export class AppComponent { targetElement: Element; constructor() { this.targetElement = document.querySelector('.test-div') as Element; } }
Vue
App.vue<template> <DxFileUploader ... :drop-zone="targetElement" > </DxFileUploader> </template> <script> import { DxFileUploader } from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, data() { return { targetElement: null } }, mounted() { this.targetElement = document.querySelector('.test-div'); } }; </script>
React
App.jsimport React, { useEffect, useState } from 'react'; import FileUploader from 'devextreme-react/file-uploader'; // ... function App() { const [targetElement, setTargetElement] = useState(null); useEffect(() => { setTargetElement(document.querySelector('.test-div')); }, []); return ( <FileUploader ... dropZone={targetElement} > </FileUploader> ); }
See Also
elementAttr
Specifies the global attributes to be attached to the UI component's container 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;
height
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"20vh"
,"80%"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
hoverStateEnabled
Specifies whether the FileUploader component changes the state of all its buttons when users hover over them.
inputAttr
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 ], // ... })
Vue
<template> <DxFileUploader :input-attr="inputAttr" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxFileUploader from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, data() { return { inputAttr: { id: 'inputId' } } } } </script>
React
import 'devextreme/dist/css/dx.light.css'; import FileUploader from 'devextreme-react/file-uploader'; const inputAttr = { id: 'inputId' }; export default function App() { return ( <FileUploader inputAttr={inputAttr} /> ); }
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
The FileUploader provides alternative validation properties: maxFileSize, minFileSize, and allowedFileExtensions.
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".
name
Specifies the value passed to the name attribute of the underlying input element. Required to access uploaded files on the server.
See Also
onBeforeSend
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
file |
An uploaded file. |
|
model | any |
Model data. Available only if Knockout is used. |
request |
An XMLHttpRequest for the file. |
|
uploadInfo |
An object that provides information about the file upload session. |
jQuery
$(function() { $("#fileUploaderContainer").dxFileUploader({ // ... onBeforeSend: function(e) { e.request.withCredentials = true; } }); });
Angular
<dx-file-uploader (onBeforeSend)="onBeforeSend($event)"> <!-- ... --> </dx-file-uploader>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { onBeforeSend(e){ e.request.withCredentials = true; } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFileUploaderModule } from 'devextreme-angular'; @NgModule({ imports: [ DxFileUploaderModule ], declarations: [AppComponent], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxFileUploader :on-before-send="onBeforeSend" > </DxFileUploader> </template> <script> import 'devextreme/dist/css/dx.light.css'; import { DxFileUploader // ... } from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader // ... }, methods: { onBeforeSend(e) { e.request.withCredentials = true; } }, data() { return { //... }; } }; </script>
React
import React from 'react'; import FileUploader from 'devextreme-react/file-uploader'; const App = () => { const onBeforeSend = (e) => { e.request.withCredentials = true; }; return ( <FileUploader onBeforeSend={onBeforeSend}> <!-- ... --> </FileUploader> ); }; export default App;
ASP.NET MVC Controls
@(Html.DevExtreme().FileUploader() .OnBeforeSend("onBeforeSend"); // ... ) <script> function onBeforeSend(e) { e.request.withCredentials = true; } </script>
ASP.NET Core Controls
@(Html.DevExtreme().FileUploader() .OnBeforeSend("onBeforeSend"); // ... ) <script> function onBeforeSend(e) { e.request.withCredentials = true; } </script>
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model | any |
Model data. Available only when using Knockout. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model | any |
Model data. Available only if you use Knockout. |
onDropZoneEnter
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
dropZoneElement |
A drop zone element. |
|
element |
The UI component'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 an EventObject or a jQuery.Event when you use jQuery. |
model | any |
Model data. Available only if Knockout is used. |
onDropZoneLeave
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
dropZoneElement |
A drop zone element. |
|
element |
The UI component'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 an EventObject or a jQuery.Event when you use jQuery. |
model | any |
Model data. Available only if Knockout is used. |
onFilesUploaded
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model | any |
Model data. Available only if Knockout is used. |
jQuery
$(function() { $("#fileUploaderContainer").dxFileUploader({ // ... onFilesUploaded: function(e) { // Your code goes here } }); });
Angular
<dx-file-uploader (onFilesUploaded)="onFilesUploaded($event)"> <!-- ... --> </dx-file-uploader>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { onFilesUploaded(e){ // ... } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFileUploaderModule } from 'devextreme-angular'; @NgModule({ imports: [ DxFileUploaderModule ], declarations: [AppComponent], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxFileUploader :on-files-uploaded="onFilesUploaded" > </DxFileUploader> </template> <script> import 'devextreme/dist/css/dx.light.css'; import { DxFileUploader // ... } from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader // ... }, methods: { onFilesUploaded(e) { // ... } }, data() { return { //... }; } }; </script>
React
import React from 'react'; import FileUploader from 'devextreme-react/file-uploader'; const App = () => { const onFilesUploaded = (e) => { // ... }; return ( <FileUploader onFilesUploaded={onFilesUploaded}> <!-- ... --> </FileUploader> ); }; export default App;
ASP.NET MVC Controls
@(Html.DevExtreme().FileUploader() .OnFilesUploaded("onFilesUploaded"); // ... ) <script> function onFilesUploaded(e) { // ... } </script>
ASP.NET Core Controls
@(Html.DevExtreme().FileUploader() .OnFilesUploaded("onFilesUploaded"); // ... ) <script> function onFilesUploaded(e) { // ... } </script>
onInitialized
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
See Also
jQuery
Angular
Vue
React
onOptionChanged
Name | Type | Description |
---|---|---|
model | any |
Model data. Available only if you use Knockout. |
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
value | any |
The modified property's new value. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#fileUploaderContainer").dxFileUploader({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-file-uploader ... (onOptionChanged)="handlePropertyChange($event)"> </dx-file-uploader>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFileUploaderModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFileUploaderModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxFileUploader ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxFileUploader from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import FileUploader from 'devextreme-react/file-uploader'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <FileUploader ... onOptionChanged={handlePropertyChange} /> ); }
onProgress
Name | Type | Description |
---|---|---|
bytesLoaded |
The total count of the uploaded bytes. |
|
bytesTotal |
The total count of bytes in the XMLHttpRequest. |
|
component |
The UI component's instance. |
|
element |
The UI component'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 an EventObject or a jQuery.Event when you use jQuery. |
file |
An uploaded file. |
|
model | any |
Model data. Available only if Knockout is used. |
request |
An XMLHttpRequest for the file. |
|
segmentSize |
The size of the uploaded file segment. |
onUploadAborted
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component'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 an EventObject or a jQuery.Event when you use jQuery. |
file |
The uploaded file. |
|
message |
The message displayed by the UI component when the file upload is cancelled. |
|
model | any |
Model data. Available only if Knockout is used. |
request |
Specifies an XMLHttpRequest for the file. |
onUploaded
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component'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 an EventObject or a jQuery.Event when you use jQuery. |
file |
The uploaded file. |
|
message |
The message displayed by the UI component when uploading is finished. |
|
model | any |
Model data. Available only if Knockout is used. |
request |
Specifies an XMLHttpRequest for the file. |
onUploadError
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component'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 an EventObject or a jQuery.Event when you use jQuery. |
file |
The uploaded file. |
|
message |
The message displayed by the UI component on uploading failure. |
|
model | any |
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
<dx-file-uploader (onUploadError)="onUploadError($event)"> <!-- ... --> </dx-file-uploader>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { onUploadError(e){ var xhttp = e.request; if (xhttp.readyState == 4 && xhttp.status == 0) { console.log("Connection refused."); } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFileUploaderModule } from 'devextreme-angular'; @NgModule({ imports: [ DxFileUploaderModule ], declarations: [AppComponent], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxFileUploader :on-upload-error="onUploadError" > </DxFileUploader> </template> <script> import 'devextreme/dist/css/dx.light.css'; import { DxFileUploader // ... } from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader // ... }, methods: { onUploadError(e) { var xhttp = e.request; if (xhttp.readyState == 4 && xhttp.status == 0) { console.log("Connection refused."); } } }, data() { return { //... }; } }; </script>
React
import React from 'react'; import FileUploader from 'devextreme-react/file-uploader'; const App = () => { const onUploadError = (e) => { var xhttp = e.request; if (xhttp.readyState == 4 && xhttp.status == 0) { console.log("Connection refused."); } }; return ( <FileUploader onUploadError={onUploadError}> <!-- ... --> </FileUploader> ); }; export default App;
ASP.NET MVC Controls
@(Html.DevExtreme().FileUploader() .OnUploadError("onUploadError"); // ... ) <script> function onUploadError(e) { var xhttp = e.request; if (xhttp.readyState == 4 && xhttp.status == 0) { console.log("Connection refused."); } } </script>
ASP.NET Core Controls
@(Html.DevExtreme().FileUploader() .OnUploadError("onUploadError"); // ... ) <script> function onUploadError(e) { var xhttp = e.request; if (xhttp.readyState == 4 && xhttp.status == 0) { console.log("Connection refused."); } } </script>
See Also
onUploadStarted
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component'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 an EventObject or a jQuery.Event when you use jQuery. |
file |
The uploaded file. |
|
model | any |
Model data. Available only if Knockout is used. |
request |
Specifies an XMLHttpRequest for the file. |
onValueChanged
Name | Type | Description |
---|---|---|
value |
Newly selected files. |
|
previousValue |
Previously selected files. |
|
model | any |
Model data. Available only if Knockout is used. |
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
readOnly
Set the readOnly property to true to enable the following functionality:
- File upload in UI is disabled. This also includes a HTML element specified in the dialogTrigger property.
- Built-in action buttons are disabled.
Note that already selected files are available for upload in readOnly mode.
readyToUploadMessage
This property makes sense only if the uploadMode property is set to "useButtons".
rtlEnabled
When this property is set to true, the UI component 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 });
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
uploadAbortedMessage
This property is only available if the uploadMode property is set to "instantly".
uploadButtonText
The property makes sense only if the uploadMode property is set to "useButtons" or "instantly".
uploadChunk
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({ uploadChunk: function(file, uploadInfo) { // your code } }); });
Angular
<dx-file-uploader ... [uploadChunk]="fileUploader_uploadChunk"> </dx-file-uploader>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // Uncomment the following lines if the function should be executed in the component's context // constructor() { // this.fileUploader_uploadChunk = this.fileUploader_uploadChunk.bind(this); // } fileUploader_uploadChunk(file, uploadInfo) { // ... } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFileUploaderModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFileUploaderModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxFileUploader ... :upload-chunk="fileUploader_uploadChunk" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxFileUploader from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, methods: { fileUploader_uploadChunk(file, uploadInfo) { // ... } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import FileUploader from 'devextreme-react/file-uploader'; class App extends React.Component { // Uncomment the following lines if the function should be executed in the component's context // constructor(props) { // super(props); // this.fileUploader_uploadChunk = this.fileUploader_uploadChunk.bind(this); // } fileUploader_uploadChunk(file, uploadInfo) { // ... } render() { return ( <FileUploader ... uploadChunk={this.fileUploader_uploadChunk} /> ); } } export default App;
ASP.NET Core Controls
@(Html.DevExtreme().FileUploader() @* ... *@ .UploadChunk("uploadChunk") ) <script type="text/javascript"> function uploadChunk(file, uploadInfo) { // ... } </script>
ASP.NET MVC Controls
@(Html.DevExtreme().FileUploader() @* ... *@ .UploadChunk("uploadChunk") ) <script type="text/javascript"> function uploadChunk(file, uploadInfo) { // ... } </script>
uploadCustomData
jQuery
$(function() { $("#fileUploaderContainer").dxFileUploader({ // ... uploadCustomData: { __RequestVerificationToken: document.getElementsByName("__RequestVerificationToken")[0].value } }); });
Angular
<dx-file-uploader id="fileUploader"> [uploadCustomData]="{ __RequestVerificationToken: document.getElementsByName("__RequestVerificationToken")[0].value }" <!-- ... --> </dx-file-uploader>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFileUploaderModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFileUploaderModule ], //... }) export class AppModule { }
Vue
<template> <DxFileUploader :upload-custom-data="uploaderCustomData" > </DxFileUploader> </template> <script> import 'devextreme/dist/css/dx.light.css'; import { DxFileUploader } from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, data() { return { uploaderCustomData: { __RequestVerificationToken: document.getElementsByName("__RequestVerificationToken")[0].value } }; } }; </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import FileUploader from 'devextreme-react/file-uploader'; const uploaderCustomData = { __RequestVerificationToken: document.getElementsByName("__RequestVerificationToken")[0].value }; class App extends React.Component { render() { return ( <FileUploader uploadCustomData={uploaderCustomData} > </FileUploader> ); } } export default App;
ASP.NET MVC Controls
@(Html.DevExtreme().FileUploader() .UploadCustomData(new[] { __RequestVerificationToken: document.getElementsByName("__RequestVerificationToken")[0].value }) // ... )
ASP.NET Core Controls
@(Html.DevExtreme().FileUploader() .UploadCustomData(new[] { __RequestVerificationToken: document.getElementsByName("__RequestVerificationToken")[0].value }) // ... )
uploadedMessage
The property makes sense only if the uploadMode property is set to "useButtons" or "instantly".
uploadFailedMessage
The property makes sense only if the uploadMode property is set to "useButtons" or "instantly".
uploadFile
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); // ... } }); });
Angular
<dx-file-uploader ... [uploadFile]="fileUploader_uploadFile"> </dx-file-uploader>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // Uncomment the following lines if the function should be executed in the component's context // constructor() { // this.fileUploader_uploadFile = this.fileUploader_uploadFile.bind(this); // } fileUploader_uploadFile(file, progressCallback) { // your code progressCallback(100); // ... progressCallback(200); // ... } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFileUploaderModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFileUploaderModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxFileUploader ... :upload-file="fileUploader_uploadFile" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxFileUploader from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader }, methods: { fileUploader_uploadFile(file, progressCallback) { // your code progressCallback(100); // ... progressCallback(200); // ... } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import FileUploader from 'devextreme-react/file-uploader'; class App extends React.Component { // Uncomment the following lines if the function should be executed in the component's context // constructor(props) { // super(props); // this.fileUploader_uploadFile = this.fileUploader_uploadFile.bind(this); // } fileUploader_uploadFile(file, progressCallback) { // your code progressCallback(100); // ... progressCallback(200); // ... } render() { return ( <FileUploader ... uploadFile={this.fileUploader_uploadFile} /> ); } } export default App;
ASP.NET Core Controls
@(Html.DevExtreme().FileUploader() @* ... *@ .UploadFile("uploadFile") ) <script type="text/javascript"> function uploadFile(file, progressCallback) { // your code progressCallback(100); // ... progressCallback(200); // ... } </script>
ASP.NET MVC Controls
@(Html.DevExtreme().FileUploader() @* ... *@ .UploadFile("uploadFile") ) <script type="text/javascript"> function uploadFile(file, progressCallback) { // your code progressCallback(100); // ... progressCallback(200); // ... } </script>
uploadMethod
The property makes sense only if the uploadMode property is set to "useButtons" or "instantly".
uploadMode
Depending on the uploadMode, the FileUploader UI component uses an HTML form or a FormData interface with a series of Ajax requests to upload files. The uploadMode property 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.
See Also
uploadUrl
The property makes sense only if the uploadMode property is set to "useButtons" or "instantly".
validationError
Information on the broken validation rule. Contains the first item from the validationErrors array.
validationStatus
The following table illustrates the validation status indicators:
validationStatus | Indicator |
---|---|
"pending" |
|
"valid" |
|
"invalid" |
When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:
jQuery
$(function() { const fileUploader = $("#fileUploaderContainer").dxFileUploader({ // ... }).dxFileUploader("instance"); function setInvalidStatus(message) { fileUploader.option({ validationStatus: "invalid", validationErrors: [{ message: message }] }); } });
Angular
<dx-file-uploader [validationStatus]="validationStatus" [validationErrors]="validationErrors"> </dx-file-uploader>
// ... export class AppComponent { validationStatus: string = "valid"; validationErrors: any; // ... setInvalidStatus(message) { this.validationStatus = "invalid"; this.validationErrors = [{ message: message }]; } }
Vue
<template> <DxFileUploader ... :validation-status="validationStatus" :validation-errors="validationErrors" /> </template> <script> // ... export default { // ... data() { return { validationStatus: "valid", validationErrors: [] } }, methods: { setInvalidStatus(message) { this.validationStatus = "invalid"; this.validationErrors = [{ message: message }]; } } } </script>
React
import React, { useState } from 'react'; // ... function App() { const [validationStatus, setValidationStatus] = useState("valid"); const [validationErrors, setValidationErrors] = useState([]); const setInvalidStatus = message => { setValidationStatus("invalid"); setValidationErrors([{ message: message }]); } return ( <FileUploader validationStatus={validationStatus} validationErrors={validationErrors} /> ); }; export default App;
value
Specifies a File instance representing the selected file. Read-only when uploadMode is "useForm".
width
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"20vw"
,"80%"
,"auto"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
If you have technical questions, please create a support ticket in the DevExpress Support Center.