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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
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
DevExpress.ui.dxFileManager.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the FileManager options } });
Angular
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()
After calling this method, remove the DOM element associated with the widget:
$("#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
<dx-file-manager ... *ngIf="condition"> </dx-file-manager>
Vue
<template> <DxFileManager ... v-if="condition"> </DxFileManager> </template> <script> import DxFileManager from 'devextreme-vue/file-manager'; export default { components: { DxFileManager } } </script>
React
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()
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getCurrentDirectory()
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)
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
instance()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
refresh()
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
The following example illustrates how to use this method:
jQuery
$(function() { var fileManager = $("#file-manager").dxFileManager({ name: "fileManager", fileProvider: 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)
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.