Angular FileUploader Methods
abortUpload()
var uploadControl = $("#uploaderContainer").dxFileUploader("instance"); uploadControl.abortUpload()
The abortUpload method works differently in the following upload modes:
useForm: The method is not supported in this mode.
useButtons: Cancels the file upload and makes the file available for upload.
instantly: Cancels the file upload.
abortUpload(file)
var uploadControl = $("#uploaderContainer").dxFileUploader("instance"); uploadControl.abortUpload(uploader.option('value[1]'))
The abortUpload method works differently in the following upload modes:
useForm: The method is not supported in this mode.
useButtons: Cancels the file upload and makes the file available for upload.
instantly: Cancels the file upload.
abortUpload(fileIndex)
var uploadControl = $("#uploaderContainer").dxFileUploader("instance"); uploadControl.abortUpload(1)
The abortUpload method works differently in the following upload modes:
useForm: The method is not supported in this mode.
useButtons: Cancels the file upload and makes the file available for upload.
instantly: Cancels the file upload.
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 FileUploader UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxFileUploader.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the FileUploader properties } });
Angular
import FileUploader from "devextreme/ui/file_uploader"; // ... export class AppComponent { constructor () { FileUploader.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the FileUploader properties } }); } }
Vue
<template> <div> <DxFileUploader id="fileUploader1" /> <DxFileUploader id="fileUploader2" /> </div> </template> <script> import DxFileUploader from "devextreme-vue/file-uploader"; import FileUploader from "devextreme/ui/file_uploader"; FileUploader.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the FileUploader properties } }); export default { components: { DxFileUploader } } </script>
React
import React, {useEffect} from "react"; import dxFileUploader from "devextreme/ui/file_uploader"; import FileUploader from "devextreme-react/file-uploader"; export default function App() { useEffect(() => { dxFileUploader.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the FileUploader properties } }) }); return ( <div> <FileUploader id="fileUploader1" /> <FileUploader id="fileUploader2" /> </div> ) }
dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myFileUploader").dxFileUploader("dispose"); $("#myFileUploader").remove();
Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-file-uploader ... *ngIf="condition"> </dx-file-uploader>
Vue
<template> <DxFileUploader ... v-if="condition"> </DxFileUploader> </template> <script> import DxFileUploader from 'devextreme-vue/file-uploader'; export default { components: { DxFileUploader } } </script>
React
import React from 'react'; import FileUploader from 'devextreme-react/file-uploader'; function DxFileUploader(props) { if (!props.shouldRender) { return null; } return ( <FileUploader ... > </FileUploader> ); } class App extends React.Component { render() { return ( <DxFileUploader shouldRender="condition" /> ); } } export default App;
See Also
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the FileUploader instance found in an element with the myFileUploader
ID:
// Modular approach import FileUploader from "devextreme/ui/file_uploader"; ... let element = document.getElementById("myFileUploader"); let instance = FileUploader.getInstance(element) as FileUploader; // Non-modular approach let element = document.getElementById("myFileUploader"); let instance = DevExpress.ui.dxFileUploader.getInstance(element);
See Also
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
removeFile(file)
removeFile(fileIndex)
var uploadControl = $("#uploaderContainer").dxFileUploader("instance"); uploadControl.removeFile(1)
upload()
var uploadControl = $("#file-uploader").dxFileUploader("instance"); uploadControl.upload();
upload(file)
var uploadControl = $("#file-uploader").dxFileUploader("instance"); uploadControl.upload(uploader.option('value[1]'));
upload(fileIndex)
var uploadControl = $("#file-uploader").dxFileUploader("instance"); uploadControl.upload(1);
If you have technical questions, please create a support ticket in the DevExpress Support Center.