Methods

This section describes methods that control the FileManager widget.

beginUpdate()

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

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

defaultOptions(rule)

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

Parameters:
rule:

Object

The component's default device options.

Object structure:
Name Type Description
device

Device

|

Array<Device>

|

Function

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

options

Object

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the FileManager widget in an application executed on the desktop.

jQuery
JavaScript
DevExpress.ui.dxFileManager.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the FileManager options
    }
});
Angular
TypeScript
import FileManager from "devextreme/ui/file_manager";
// ...
export class AppComponent {
    constructor () {
        FileManager.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the FileManager options
            }
        });
    }
}
Vue
<template>
    <div>
        <DxFileManager id="fileManager1" />
        <DxFileManager id="fileManager2" />
    </div>
</template>
<script>
import DxFileManager from "devextreme-vue/file-manager";
import FileManager from "devextreme/ui/file_manager";

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

export default {
    components: {
        DxFileManager
    }
}
</script>
React
import React from "react";
import dxFileManager from "devextreme/ui/file_manager";
import FileManager from "devextreme-react/file-manager";

class App extends React.Component {
    render () {
        dxFileManager.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the FileManager options
            }
        })
        return (
            <div>
                <FileManager id="fileManager1" />
                <FileManager id="fileManager2" />
            </div>
        )
    }
}

export default App;

dispose()

Disposes of all the resources allocated to the FileManager instance.

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

JavaScript
$("#myFileManager").dxFileManager("dispose");
$("#myFileManager").remove();

Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular
app.component.html
<dx-file-manager ...
    *ngIf="condition">
</dx-file-manager>
Vue
App.vue
<template>
    <DxFileManager ...
        v-if="condition">
    </DxFileManager>
</template>

<script>
import DxFileManager from 'devextreme-vue/file-manager';

export default {
    components: {
        DxFileManager
    }
}
</script>
React
App.js
import React from 'react';

import FileManager from 'devextreme-react/file-manager';

function DxFileManager(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <FileManager ... >    
        </FileManager>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxFileManager shouldRender="condition" />
        );
    }
}
export default App;
See Also

element()

Gets the root widget element.

Return Value:

Element (jQuery or HTML)

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

See Also

endUpdate()

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

Main article: beginUpdate()

See Also

focus()

Sets focus on the widget.

See Also

getCurrentDirectory()

Gets the current directory object.

Return Value:

Object

An object that contains information about the FileManager item.

This method returns the following FileManager item's parameters:

  • pathInfo: Array<Object> - Information about the item's path.
  • parentPath: string - The item's parent path.
  • key: string - The item's key.
  • relativeName: string - The item's relative name.
  • isDirectory: boolean - The item's type (file or directory).
  • isRoot: boolean - The directory type (standard or root).
  • size: number - The item size.
  • dateModified: Date - The item's modified date.
  • thumbnail: string - The item's thumbnail URL.
  • tooltipText: string - The item's tooltip text.

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:
element:

DOM Node

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the FileManager instance found in an element with the myFileManager ID:

// Modular approach
import FileManager from "devextreme/ui/file_manager";
...
let element = document.getElementById("myFileManager");
let instance = FileManager.getInstance(element) as FileManager;

// Non-modular approach
let element = document.getElementById("myFileManager");
let instance = DevExpress.ui.dxFileManager.getInstance(element);
See Also

getSelectedItems()

Gets the selected items.

Return Value: Array<Object>

The selected items.

instance()

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

Return Value:

FileManager

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

FileManager

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

FileManager

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

FileManager

The object for which this method is called.

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

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

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

Return Value:

FileManager

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.

See Also

option()

Gets all widget options.

Return Value:

Object

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

refresh()

Reloads data and repaints the widget.

Return Value:

Promise<any> (jQuery or native)

A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.

View Demo

The following example illustrates how to use this method:

jQuery
JavaScript
$(function() {
    var fileManager = $("#file-manager").dxFileManager({
        name: "fileManager",
        fileSystemProvider: fileSystem,
        contextMenu: {
            items: [
                // ...
                {
                    text: "Share",
                    icon: "arrowright",
                    beginGroup: true,
                    onClick: shareItem
                },
                {
                    text: "Unshare",
                    icon: "revert",
                    onClick: unshareItem
                }
                // ...
            ]
        }
    }).dxFileManager("instance");

    // ...

    function shareItem() {
        changeSharedState(true);
    }

    function unshareItem() {
        changeSharedState(false);
    }

    function changeSharedState(isShared) {
        fileManager.getSelectedItems().forEach(function(item) {
            item.dataItem.shared = isShared;
        });
        fileManager.refresh();
    }
});

registerKeyHandler(key, handler)

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

Parameters:
key:

String

A key.

handler:

Function

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

See Also

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

See Also

resetOption(optionName)

Resets an option to its default value.

Parameters:
optionName:

String

An option's name.

See Also