DxFileInput.CancelFilesUpload(IEnumerable<UploadFileInfo>) Method
Cancels upload processes for specified files.
Namespace: DevExpress.Blazor
Assembly: DevExpress.Blazor.v24.1.dll
NuGet Package: DevExpress.Blazor
Declaration
public void CancelFilesUpload(
IEnumerable<UploadFileInfo> fileInfos
)
Parameters
Name | Type | Description |
---|---|---|
fileInfos | IEnumerable<UploadFileInfo> | A collection of files whose upload operations 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:
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 active upload processes for first two files:
<DxFileInput @ref="MyFileInput"
AllowMultiFileUpload="true"
UploadMode="UploadMode.OnButtonClick"
SelectedFilesChanged="@SelectedFilesChanged"
FilesUploading="OnFilesUploading" />
<DxButton Text="Cancel Upload of Two Files" Click="OnCancelButtonClick" />
@code {
DxFileInput MyFileInput { get; set; }
IEnumerable<UploadFileInfo> Files { get; set; }
protected void SelectedFilesChanged(IEnumerable<UploadFileInfo> files) {
Files = files;
}
void OnCancelButtonClick() {
if (Files != null)
MyFileInput.CancelFilesUpload(Files.Take(2));
}
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.