A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://js.devexpress.com/Documentation/ApiReference/UI_Components/dxFileUploader/Methods/ below:

React FileUploader Methods | React Documentation

This section describes methods that manage the FileUploader UI component.

Cancels the file upload.

jQuery
var uploadControl = $("#uploaderContainer").dxFileUploader("instance");
uploadControl.abortUpload()

The abortUpload method works differently in the following upload modes:

Cancels the file upload.

Parameters:

The file for which the upload is cancelled.

jQuery
var uploadControl = $("#uploaderContainer").dxFileUploader("instance");
uploadControl.abortUpload(uploader.option('value[1]'))

The abortUpload method works differently in the following upload modes:

Cancels the file upload.

Parameters:

The index of the file for which the upload is cancelled.

jQuery
var uploadControl = $("#uploaderContainer").dxFileUploader("instance");
uploadControl.abortUpload(1)

The abortUpload method works differently in the following upload modes:

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

Resets the value property to the default value.

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

Parameters:

The component's default device properties.

Object structure:

Name Type Description device

Device

|

Function

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

options

Object

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.

jQuery
DevExpress.ui.dxFileUploader.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the FileUploader properties
    }
});
Angular
import FileUploader, { Properties } from "devextreme/ui/file_uploader";
// ...
export class AppComponent {
    constructor () {
        FileUploader.defaultOptions<Properties>({
            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 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:

jQuery
const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    DevExpress.ui.dxFileUploader.defaultOptions({ 
        device: deviceConfig,
        options: {
            // Here go the FileUploader properties
        }
    });
});
Angular
import FileUploader, { Properties } from "devextreme/ui/file_uploader";
// ...
export class AppComponent {
    constructor () {
        const devicesConfig = [
            { deviceType: 'desktop' },
            { deviceType: 'tablet' },
            { deviceType: 'phone' },
        ];

        devicesConfig.forEach(deviceConfig => {
            FileUploader.defaultOptions<Properties>({
                device: deviceConfig,
                options: {
                    // Here go the FileUploader properties
                }
            });
        });
    }
}
Vue
<template>
    <div>
        <DxFileUploader />
    </div>
</template>
<script>
import DxFileUploader from "devextreme-vue/file-uploader";
import FileUploader from "devextreme/ui/file_uploader";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    FileUploader.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the FileUploader properties
        }
    });
});

export default {
    components: {
        DxFileUploader
    }
}
</script>
React
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>
    )
}

Disposes of all the resources allocated to the FileUploader instance.

jQuery

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

$("#myFileUploader").dxFileUploader("dispose");
$("#myFileUploader").remove();
Angular

Use conditional rendering instead of this method:

<dx-file-uploader ...
    *ngIf="condition">
</dx-file-uploader>
Vue

Use conditional rendering instead of this method:

<template>
    <DxFileUploader ...
        v-if="condition">
    </DxFileUploader>
</template>

<script>
import DxFileUploader from 'devextreme-vue/file-uploader';

export default {
    components: {
        DxFileUploader
    }
}
</script>
React

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;

Gets the root UI component element.

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

Sets focus on the UI component.

Gets the instance of a UI component found using its DOM node.

Parameters:

The UI component's container.

The UI component's instance.

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

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

This UI component's instance.

Detaches all event handlers from a single event.

The object for which this method is called.

Detaches a particular event handler from a single event.

Parameters:

The event's name.

The event's handler.

The object for which this method is called.

Subscribes to an event.

Parameters:

The event's name.

The event's handler.

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

Subscribes to events.

Parameters:

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

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

Gets the value of a single property.

Parameters:

The property's name or full path.

Return Value: any

This property's value.

Updates the value of a single property.

Parameters:

The property's name or full path.

optionValue: any

This property's new value.

Updates the values of several properties.

Parameters:

Options with their new values.

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

Parameters:

A key.

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:

A custom handler for a key cancels the default handler for this key.

See Also

Removes a file.

Parameters:

The file that is being removed.

The

removeFile

method is not supported in

useForm upload mode

.

Removes a file with the specified index.

jQuery
var uploadControl = $("#uploaderContainer").dxFileUploader("instance");
uploadControl.removeFile(1)

The

removeFile

method is not supported in

useForm upload mode

.

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

Resets the value property to the value passed as an argument.

Resets a property to its default value.

Uploads all the selected files.

jQuery
var uploadControl = $("#file-uploader").dxFileUploader("instance");
uploadControl.upload();

The

upload

method is not supported in

useForm upload mode

. In

instantly

upload mode, the

upload

method is useful if you use the

value

property to select a file(s) you want to upload.

Uploads the specified file.

Parameters:

The file that is being uploaded.

jQuery
var uploadControl = $("#file-uploader").dxFileUploader("instance");
uploadControl.upload(uploader.option('value[1]'));

The

upload

method is not supported in

useForm upload mode

. In

instantly

upload mode, the

upload

method is useful if you use the

value

property to select a file(s) you want to upload.

Uploads a file with the specified index.

jQuery
var uploadControl = $("#file-uploader").dxFileUploader("instance");
uploadControl.upload(1);

The

upload

method is not supported in

useForm upload mode

. In

instantly

upload mode, the

upload

method is useful if you use the

value

property to select a file(s) you want to upload.

Feel free to share topic-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you for the feedback!

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4