Class
TelerikUpload

The class for the Telerik Upload component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class TelerikUpload : TelerikUploadBase<UploadFileInfo>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikUploadBase<UploadFileInfo>TelerikUpload

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members TelerikUploadBase<UploadFileInfo>.OnAfterRenderAsync(bool)TelerikUploadBase<UploadFileInfo>.ClearFiles()TelerikUploadBase<UploadFileInfo>.OpenSelectFilesDialog()TelerikUploadBase<UploadFileInfo>.SelectFilesButtonTemplateTelerikUploadBase<UploadFileInfo>.EnabledTelerikUploadBase<UploadFileInfo>.MultipleTelerikUploadBase<UploadFileInfo>.AcceptTelerikUploadBase<UploadFileInfo>.AllowedExtensionsTelerikUploadBase<UploadFileInfo>.MinFileSizeTelerikUploadBase<UploadFileInfo>.MaxFileSizeTelerikUploadBase<UploadFileInfo>.IdTelerikUploadBase<UploadFileInfo>.CaptureTelerikUploadBase<UploadFileInfo>.DropZoneIdTelerikUploadBase<UploadFileInfo>.AriaDescribedByTelerikUploadBase<UploadFileInfo>.AriaLabelledByBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.Dispose()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnParametersSet()ComponentBase.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.SetParametersAsync(ParameterView)

Constructors

TelerikUpload()

Declaration

cs-api-definition
public TelerikUpload()

Properties

AutoUpload

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

Declaration

cs-api-definition
[Parameter]
public bool AutoUpload { get; set; }

Property Value

bool

Files

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

Declaration

cs-api-definition
[Parameter]
public IEnumerable<UploadFileInfo> Files { get; set; }

Property Value

IEnumerable<UploadFileInfo>

OnCancel

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<UploadCancelEventArgs> OnCancel { get; set; }

Property Value

EventCallback<UploadCancelEventArgs>

OnClear

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<UploadClearEventArgs> OnClear { get; set; }

Property Value

EventCallback<UploadClearEventArgs>

OnError

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<UploadErrorEventArgs> OnError { get; set; }

Property Value

EventCallback<UploadErrorEventArgs>

OnProgress

Triggered when the progress of the file upload is changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<UploadProgressEventArgs> OnProgress { get; set; }

Property Value

EventCallback<UploadProgressEventArgs>

OnRemove

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<UploadEventArgs> OnRemove { get; set; }

Property Value

EventCallback<UploadEventArgs>

OnSelect

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<UploadSelectEventArgs> OnSelect { get; set; }

Property Value

EventCallback<UploadSelectEventArgs>

OnSuccess

Triggered when an upload or remove request is successful.

Declaration

cs-api-definition
[Parameter]
public EventCallback<UploadSuccessEventArgs> OnSuccess { get; set; }

Property Value

EventCallback<UploadSuccessEventArgs>

OnUpload

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<UploadEventArgs> OnUpload { get; set; }

Property Value

EventCallback<UploadEventArgs>

PopupId

Declaration

cs-api-definition
public string PopupId { get; }

Property Value

string

RemoveField

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

Declaration

cs-api-definition
[Parameter]
public string RemoveField { get; set; }

Property Value

string

RemoveUrl

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

Declaration

cs-api-definition
[Parameter]
public string RemoveUrl { get; set; }

Property Value

string

SaveField

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

Declaration

cs-api-definition
[Parameter]
public string SaveField { get; set; }

Property Value

string

SaveUrl

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

Declaration

cs-api-definition
[Parameter]
public string SaveUrl { get; set; }

Property Value

string

WithCredentials

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

Declaration

cs-api-definition
[Parameter]
public bool WithCredentials { get; set; }

Property Value

bool

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnInitialized()

Declaration

cs-api-definition
protected override void OnInitialized()

Overrides ComponentBase.OnInitialized()

UploadFiles()

Uploads all valid files.

Declaration

cs-api-definition
public void UploadFiles()