Class TelerikUpload

The class for the Telerik Upload component.

Inheritance
System.Object
BaseComponent
TelerikUploadBase<UploadFileInfo>
TelerikUpload
Inherited Members
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class TelerikUpload : TelerikUploadBase<UploadFileInfo>, IDisposable, IUploadContainer

Constructors

TelerikUpload()

Declaration
public TelerikUpload()

Properties

AutoUpload

Specifies if the selected files will be uploaded automatically. The default value is true.

Declaration
public bool AutoUpload { get; set; }
Property Value
System.Boolean

Files

Used to preload a list of files to the Upload component during initialization.

Declaration
public IEnumerable<UploadFileInfo> Files { get; set; }
Property Value
System.Collections.Generic.IEnumerable<UploadFileInfo>

OnCancel

Triggered when the user clicks the Cancel icon of a file that is currently uploading.

Declaration
public EventCallback<UploadCancelEventArgs> OnCancel { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<UploadCancelEventArgs>

OnClear

Triggered when the user clicks the Clear button below the file list.

Declaration
public EventCallback<UploadClearEventArgs> OnClear { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<UploadClearEventArgs>

OnError

Triggered when an upload or remove request fails in the controller.

Declaration
public EventCallback<UploadErrorEventArgs> OnError { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<UploadErrorEventArgs>

OnProgress

Triggered when the progress of the file upload is changed.

Declaration
public EventCallback<UploadProgressEventArgs> OnProgress { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<UploadProgressEventArgs>

OnRemove

Triggered when the users clicks the Remove (X) button of an uploaded file.

Declaration
public EventCallback<UploadEventArgs> OnRemove { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<UploadEventArgs>

OnSelect

Triggered when the user selects one or more new files for upload.

Declaration
public EventCallback<UploadSelectEventArgs> OnSelect { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<UploadSelectEventArgs>

OnSuccess

Triggered when an upload or remove request is successful.

Declaration
public EventCallback<UploadSuccessEventArgs> OnSuccess { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<UploadSuccessEventArgs>

OnUpload

Triggered before a file is uploaded. By default, it will fire immediately after OnSelect, unless AutoUpload="false".

Declaration
public EventCallback<UploadEventArgs> OnUpload { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<UploadEventArgs>

RemoveField

Sets the FormData key which contains the list of file names that are submitted to removeUrl.

Declaration
public string RemoveField { get; set; }
Property Value
System.String

RemoveUrl

The URL of the handler which is responsible for the removal of the uploaded files (if any).

Declaration
public string RemoveUrl { get; set; }
Property Value
System.String

SaveField

Sets the FormData key which contains the files submitted to saveUrl.

Declaration
public string SaveField { get; set; }
Property Value
System.String

SaveUrl

The URL of the handler that will receive the submitted file(s).

Declaration
public string SaveUrl { get; set; }
Property Value
System.String

WithCredentials

Specifies if credentials (cookies, headers) will be sent for cross-site requests.

Declaration
public bool WithCredentials { get; set; }
Property Value
System.Boolean

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

OnInitialized()

Declaration
protected override void OnInitialized()

OpenFileSelectAsync()

Opens the browser file selection dialog.

Declaration
public Task OpenFileSelectAsync()
Returns
System.Threading.Tasks.Task

UploadFiles()

Uploads all valid files.

Declaration
public void UploadFiles()