JavaScript/jQuery FileManager Methods
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the FileManager UI component in an application executed on the desktop.
- <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 properties
- }
- });
- export default {
- components: {
- DxFileManager
- }
- }
- </script>
dispose()
Use conditional rendering instead of this method:
- <template>
- <DxFileManager ...
- v-if="condition">
- </DxFileManager>
- </template>
- <script>
- import DxFileManager from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- }
- }
- </script>
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 UI component 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
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
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:
- <template>
- <DxFileManager
- :ref="fileManagerRef">
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- } from 'devextreme-vue/file-manager';
- const fileManagerRef = 'fileManager';
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- fileManagerRef
- }
- },
- computed: {
- fileManager: function() {
- return this.$refs[fileManagerRef].instance;
- }
- },
- methods: {
- yourCustomMethod(){
- this.fileManager.refresh();
- // ...
- }
- }
- };
- </script>
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject 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
If you have technical questions, please create a support ticket in the DevExpress Support Center.