TelerikUpload
A component that lets users select and upload files with progress, validation, and events.
Supports endpoints via SaveUrl/RemoveUrl and form keys SaveField/RemoveField, credentials with WithCredentials, auto/manual upload through AutoUpload, multiple selection, allowed extensions and size limits, chunk upload via UploadChunkSettings, preloaded Files, and lifecycle events (OnSelect, OnUpload, OnProgress, OnSuccess, OnError, OnCancel, OnClear, OnPause, OnResume).
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Syntax:
public class TelerikUpload : TelerikUploadBase<UploadFileInfo, UploadFileTemplateContext, UploadFileInfoTemplateContext>, IComponent, IHandleEvent, IHandleAfterRender, IDisposableInheritance: objectComponentBaseBaseComponentTelerikUploadBase<UploadFileInfo, UploadFileTemplateContext, UploadFileInfoTemplateContext>TelerikUpload
Implements:
Inherited Members
Constructors
public TelerikUpload()Properties
Automatically uploads files after selection when set to true (default). Set to false to require a manual upload button click. Example: false.
[Parameter]
public bool AutoUpload { get; set; }Preloads a list of files into the Upload component on initialization. Example: bind to a list of UploadFileInfo. Useful for displaying previously uploaded files.
[Parameter]
public IEnumerable<UploadFileInfo> Files { get; set; }Fires when a user clicks Cancel on a file that is uploading. Use to stop upload and update UI. Example: cancel upload of large file.
[Parameter]
public EventCallback<UploadCancelEventArgs> OnCancel { get; set; }Fires when the Clear button is clicked. Use to reset the file list or clear UI. Example: remove all files from the list.
[Parameter]
public EventCallback<UploadClearEventArgs> OnClear { get; set; }Fires when an upload or remove request fails. Use to display error messages or retry logic. Example: show error notification if server returns 500.
[Parameter]
public EventCallback<UploadErrorEventArgs> OnError { get; set; }Fires when the Pause button is clicked. Use to pause chunked uploads. Only available when chunk upload and Resumable are enabled.
[Parameter]
public EventCallback<UploadPauseEventArgs> OnPause { get; set; }Fires when upload progress changes. Use to update progress bars or UI. Example: show "Uploading 50%".
[Parameter]
public EventCallback<UploadProgressEventArgs> OnProgress { get; set; }Fires when a user clicks Remove (X) on a file. Use to handle file deletion logic. Example: remove file from server or update UI. See OnError for failure handling.
[Parameter]
public EventCallback<UploadEventArgs> OnRemove { get; set; }Fires when the Resume button is clicked. Use to resume paused chunked uploads. Only available when chunk upload and Resumable are enabled.
[Parameter]
public EventCallback<UploadResumeEventArgs> OnResume { get; set; }Fires when users select new files for upload. Use to validate or filter files before upload. Example: check file type or size. See OnUpload for upload logic.
[Parameter]
public EventCallback<UploadSelectEventArgs> OnSelect { get; set; }Fires when an upload or remove request succeeds. Use to update UI or notify users. Example: show "Upload complete" message.
[Parameter]
public EventCallback<UploadSuccessEventArgs> OnSuccess { get; set; }Fires before uploading files. Use to add custom headers or cancel upload. Example: set args.IsCancelled = true to prevent upload. Fires after OnSelect unless AutoUpload is false.
[Parameter]
public EventCallback<UploadEventArgs> OnUpload { get; set; }Sets the FormData key for file names sent to RemoveUrl. Example: "files". Change if your server expects a different key.
[Parameter]
public string RemoveField { get; set; }Sets the URL endpoint for removing uploaded files. Example: "https://myserver.com/remove". Must be configured for file deletion to work. See SaveUrl for upload endpoint.
[Parameter]
public string RemoveUrl { get; set; }Sets the FormData key for uploaded files sent to SaveUrl. Example: "files". Change if your server expects a different key.
[Parameter]
public string SaveField { get; set; }Sets the URL endpoint that receives uploaded files. Example: "https://myserver.com/upload". Required for file uploads to work. See RemoveUrl for file removal.
[Parameter]
public string SaveUrl { get; set; }Configures advanced upload settings, such as chunk upload. Use UploadChunkSettings as a child component. Example:
[Parameter]
public RenderFragment UploadSettings { get; set; }Enables sending credentials (cookies, headers) with cross-site requests. Set to true if your upload endpoint requires authentication. Example: true.
[Parameter]
public bool WithCredentials { get; set; }Methods
protected override void BuildRenderTree(RenderTreeBuilder __builder)Overrides:
Cancels the upload of the specified file and removes it from the collection.
public void CancelFile(string fileId)The unique identifier of the file to cancel.
protected override void OnInitialized()Overrides:
Pauses the upload of the file with the specified identifier, if it exists in the current collection.
public void PauseFile(string fileId)The unique identifier of the file to pause.
Removes the file with the specified identifier from the collection.
public void RemoveFile(string fileId)The unique identifier of the file to remove.
Resumes the upload process for the specified file.
public void ResumeFile(string fileId)The unique identifier of the file to resume.
Attempts to retry the upload of a file with the specified identifier.
public void RetryFile(string fileId)The unique identifier of the file to retry.
Uploads all valid files.
public void UploadFiles()