Skip to main content
All docs
V25.1
  • DxFileInput.CancelFileUpload(UploadFileInfo) Method

    Cancels the upload operation for the specified file.

    Namespace: DevExpress.Blazor

    Assembly: DevExpress.Blazor.v25.1.dll

    NuGet Package: DevExpress.Blazor

    Declaration

    public void CancelFileUpload(
        UploadFileInfo fileInfo
    )

    Parameters

    Name Type Description
    fileInfo UploadFileInfo

    A file whose upload process should be canceled.

    Remarks

    Once a user selects files in the Open dialog or drags files onto a drop zone, the File Input component adds these files to the file list. The file list displays each file’s upload status and upload, cancel, reload, and remove buttons. On the image below, the file list contains 4 files in different states:

    file list

    Handle the SelectedFilesChanged event to access the collection of files in the file list. Call the following methods to manage these files in code:

    Start Upload Cancel Upload Restart Canceled Upload Remove Files from List
    One File UploadFile CancelFileUpload ReloadFile RemoveFile
    Multiple Files UploadFiles CancelFilesUpload ReloadFiles RemoveFiles
    All Files UploadAllFiles CancelAllFilesUpload ReloadAllFiles RemoveAllFiles

    The following example displays a button that cancels the active upload operation for the first file:

    <DxFileInput @ref="MyFileInput"
                 AllowMultiFileUpload="true"
                 UploadMode="UploadMode.OnButtonClick"
                 SelectedFilesChanged="@SelectedFilesChanged"
                 FilesUploading="OnFilesUploading" />
    
    <DxButton Text="Cancel the First File Upload" Click="OnCancelButtonClick" />
    
    @code {
        DxFileInput MyFileInput { get; set; }
        UploadFileInfo File { get; set; }
    
        IEnumerable<UploadFileInfo> Files { get; set; }
    
        protected void SelectedFilesChanged(IEnumerable<UploadFileInfo> files) {
            Files = files;
        }
        void OnCancelButtonClick() {
            if (Files != null)
                MyFileInput.CancelFileUpload(Files.First());
        }
        async Task OnFilesUploading(FilesUploadingEventArgs args) {
            foreach (var file in args.Files) {
                /* The following code is intended for demonstration purposes only.
                Do not read a stream directly in memory to avoid performance and security-related issues. */
                using var stream = new System.IO.MemoryStream();
                await file.OpenReadStream(file.Size).CopyToAsync(stream);
            }
        }
    }
    

    Set the AllowCancel property to false to prevent users from canceling upload operations.

    See Also