BuyLog In
DevExtreme
All docs
V 21.1
24.2
24.1
23.2
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2.
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
All docs
V21.1

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
24.2
24.1
23.2
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2.
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
Full-text search
API Reference
UI Components
Accordion
ActionSheet
Autocomplete
BarGauge
Box
Bullet
Button
ButtonGroup
Calendar
Chart
CheckBox
CircularGauge
ColorBox
ContextMenu
DataGrid
DateBox
DeferRendering
Diagram
Draggable
Drawer
DropDownBox
DropDownButton
FileManager
Configuration
Methods
Events
File System Providers
Custom
Object
Configuration
Methods
abortFileUpload()
copyItems()
createDirectory()
deleteItems()
downloadItems()
getItems()
getItemsContent()
moveItems()
renameItem()
uploadFileChunk()
Remote
FileUploader
FilterBuilder
Form
Funnel
Gallery
Gantt
HtmlEditor
LinearGauge
List
LoadIndicator
LoadPanel
Lookup
Map
Menu
MultiView
NavBar
NumberBox
PieChart
PivotGrid
PivotGridFieldChooser
PolarChart
Popover
Popup
ProgressBar
RadioGroup
RangeSelector
RangeSlider
Resizable
ResponsiveBox
Sankey
Scheduler
ScrollView
SelectBox
SlideOut
SlideOutView
Slider
Sortable
Sparkline
SpeedDialAction
Switch
TabPanel
Tabs
TagBox
TextArea
TextBox
TileView
Toast
Toolbar
Tooltip
TreeList
TreeMap
TreeView
ValidationGroup
ValidationSummary
Validator
VectorMap
Markup Components
UI Events
CSS Classes
Data Layer
Types
Utilities
ASP.NET MVC 5
ASP.NET Core
jQuery
UI Components
Data Binding
Common Features
Migrate to the New Version

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery FileManager - Object.Methods

This section describes members used to manage file system items.

abortFileUpload()

Cancels the file upload.

Parameters:
fileData:

File

The file that is being uploaded.

uploadInfo:

UploadInfo

Information about the file upload session.

destinationDirectory:

FileSystemItem

The directory where a file system item is uploaded to.

Return Value:

Promise<any> (jQuery or native)

A Promise that is resolved after the file upload is aborted. It is a native Promise or a jQuery.Promise when you use jQuery.

copyItems()

Copies files or folders.

Parameters:
items:

Array<FileSystemItem>

The current files or folders.

destinationDirectory:

FileSystemItem

The directory where files or folders are copied to.

Return Value:

Array<Promise<any> (jQuery or native)>

An array of Promise objects. A promise at N index gets resolved after a file or folder with the same index is copied. It is a native Promise or a jQuery.Promise when you use jQuery.

createDirectory()

Creates a directory.

Parameters:
parentDirectory:

FileSystemItem

The parent directory where a new directory should be created.

name:

String

The name of the new directory.

Return Value:

Promise<any> (jQuery or native)

A Promise that is resolved after a new directory is created. It is a native Promise or a jQuery.Promise when you use jQuery.

deleteItems()

Deletes files or folders.

Parameters:
items:

Array<FileSystemItem>

The current files or folders.

Return Value:

Array<Promise<any> (jQuery or native)>

An array of Promise objects. A promise at N index gets resolved after a file or folder with the same index is deleted. It is a native Promise or a jQuery.Promise when you use jQuery.

downloadItems()

Downloads files.

Parameters:
items:

Array<FileSystemItem>

An array of files.

getItems()

Gets file system items.

Parameters:
parentDirectory:

FileSystemItem

The directory that stores file system items.

Return Value:

Promise<Array<FileSystemItem>> (jQuery or native)

A Promise that is resolved after file system items are obtained. It is a native Promise or a jQuery.Promise when you use jQuery.

getItemsContent()

Gets items content.

Parameters:
items:

Array<FileSystemItem>

The file system items.

Return Value:

Promise<Object> (jQuery or native)

A Promise that is resolved after the content of the file system items is obtained. It is a native Promise or a jQuery.Promise when you use jQuery.

moveItems()

Moves files and folders.

Parameters:
items:

Array<FileSystemItem>

The current files and folders.

destinationDirectory:

FileSystemItem

The directory where files or folders are moved to.

Return Value:

Array<Promise<any> (jQuery or native)>

An array of Promise objects. A promise at N index gets resolved after a file or folder with the same index is moved. It is a native Promise or a jQuery.Promise when you use jQuery.

renameItem()

Renames a file or folder.

Parameters:
item:

FileSystemItem

The current file or folder.

newName:

String

The new name for the file or folder.

Return Value:

Promise<any> (jQuery or native)

A Promise that is resolved after the file or folder is renamed. It is a native Promise or a jQuery.Promise when you use jQuery.

uploadFileChunk()

Uploads a file in chunks.

Parameters:
fileData:

File

The file that is being uploaded.

uploadInfo:

UploadInfo

Information about the file upload session.

destinationDirectory:

FileSystemItem

The directory where the file is uploaded to.

Return Value:

Promise<any> (jQuery or native)

A Promise that is resolved after the file uploaded. It is a native Promise or a jQuery.Promise when you use jQuery.