React FileUploader Methods
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)
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)
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()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
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.
- import dxFileUploader from "devextreme/ui/file_uploader";
- import FileUploader from "devextreme-react/file-uploader";
- dxFileUploader.defaultOptions({
- device: { deviceType: "desktop" },
- options: {
- // Here go the FileUploader properties
- }
- });
- export default function App() {
- return (
- <div>
- <FileUploader id="fileUploader1" />
- <FileUploader id="fileUploader2" />
- </div>
- )
- }
You can also set rules for multiple device types:
- import dxFileUploader from "devextreme/ui/file_uploader";
- import FileUploader from "devextreme-react/file-uploader";
- const devicesConfig = [
- { deviceType: 'desktop' },
- { deviceType: 'tablet' },
- { deviceType: 'phone' },
- ];
- devicesConfig.forEach(deviceConfig => {
- dxFileUploader.defaultOptions({
- device: deviceConfig,
- options: {
- // Here go the FileUploader properties
- }
- });
- });
- export default function App() {
- return (
- <div>
- <FileUploader />
- </div>
- )
- }
dispose()
Use conditional rendering instead of this method:
- 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;
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
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
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
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
removeFile(file)
removeFile(fileIndex)
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint()
method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
upload()
upload(file)
upload(fileIndex)
If you have technical questions, please create a support ticket in the DevExpress Support Center.