Class SfUploader

Inheritance
System.Object
Syncfusion.Blazor.BaseComponent
SfUploader
Implements
System.IDisposable
Namespace: Syncfusion.Blazor.Inputs
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfUploader : BaseComponent, IDisposable, IUploader

Constructors

SfUploader()

Declaration
public SfUploader()

Properties

AllowedExtensions

Specifies the extensions of the file types allowed in the Uploader component and pass the extensions with comma separators.

For example,if you want to upload specific image files, pass `AllowedExtensions` as ".jpg,.png".

Declaration
public string AllowedExtensions { get; set; }
Property Value
Type Description
System.String

AsyncSettings

Configures the save and remove URL to perform the upload operations in the server asynchronously.

Declaration
public UploaderAsyncSettings AsyncSettings { get; set; }
Property Value
Type Description
UploaderAsyncSettings

AutoUpload

By default, the Uploader component initiates automatic upload when the files are added in upload queue.

If you want to manipulate the files before uploading to server, disable the AutoUpload property.

The buttons "upload" and "clear" will be hided from file list when AutoUpload property is true.

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

Buttons

You can customize the default text of "browse, clear, and upload" buttons with plain text or HTML elements. The buttons' text can be customized from localization also.

If you configured both Locale and Buttons property,the Uploader component considers the Buttons property value.

Declaration
public UploaderButtonsProps Buttons { get; set; }
Property Value
Type Description
UploaderButtonsProps

ChildContent

Specifies the content that has to be passed.

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment

CssClass

Specifies the CSS class name that can be appended with root element of the Uploader. One or more custom CSS classes can be added to a Uploader.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

DirectoryUpload

Specifies a boolean value that indicates whether the folder of files can be browsed in the Uploader component.

Declaration
public bool DirectoryUpload { get; set; }
Property Value
Type Description
System.Boolean

DropArea

Specifies the drop target to handle the drag-and-drop upload. By default, the Uploader creates wrapper around file input that will act as drop target.

Declaration
public string DropArea { get; set; }
Property Value
Type Description
System.String

DropEffect

Specifies the drag operation effect to the Uploader component.

Possible values are

  • Copy
  • Move
  • Link
  • None
Declaration
public DropEffect DropEffect { get; set; }
Property Value
Type Description
DropEffect

Enabled

Specifies a boolean value that indicates whether the Uploader allows the user to interact with it.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Enable or disable persisting Uploader state between page reloads. If enabled, the Files state will be persisted.

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering Uploader in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

Files

Specifies the list of files that will be preloaded on rendering of Uploader component. The property used to view and remove the uploaded files from server.

By default, the files are configured with uploaded successfully state. The following properties are mandatory to configure the preload files:

  • Name
  • Size
  • Type
Declaration
public List<UploaderUploadedFiles> Files { get; set; }
Property Value
Type Description
System.Collections.Generic.List<UploaderUploadedFiles>

HtmlAttributes

You can add the additional html attributes such as styles, class, and more to the root element.

If you configured both property and equivalent html attributes, then the component considers the property value.

Declaration
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

ID

Specifies the id of the Uploader component.

Declaration
public override string ID { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.BaseComponent.ID

jsProperty

Declaration
protected override string jsProperty { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.BaseComponent.jsProperty

Locale

Specifies the global culture and localization of the Uploader component.

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

MaxFileSize

Specifies the maximum allowed file size to be uploaded in bytes. The property used to make sure that you cannot upload too large files.

Declaration
public double MaxFileSize { get; set; }
Property Value
Type Description
System.Double

MinFileSize

Specifies the minimum file size to be uploaded in bytes. The property used to make sure that you cannot upload empty files and small files.

Declaration
public double MinFileSize { get; set; }
Property Value
Type Description
System.Double

Multiple

Specifies a boolean value that indicates whether the multiple files can be browsed or dropped simultaneously in the Uploader component.

Declaration
public bool Multiple { get; set; }
Property Value
Type Description
System.Boolean

nameSpace

Declaration
protected override string nameSpace { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.BaseComponent.nameSpace

SequentialUpload

By default, the file Uploader component is processing the multiple files simultaneously.

If SequentialUpload property is enabled, the file upload component performs the upload one after the other.

Declaration
public bool SequentialUpload { get; set; }
Property Value
Type Description
System.Boolean

ShowFileList

Specifies a boolean value that indicates whether the default file list can be rendered. The property used to prevent default file list and design own template for file list.

Declaration
public bool ShowFileList { get; set; }
Property Value
Type Description
System.Boolean

TabIndex

Specifies the tab order of the component.

Declaration
public int TabIndex { get; set; }
Property Value
Type Description
System.Int32

Template

Specifies the HTML string that used to customize the content of each file in the list.

Declaration
public string Template { get; set; }
Property Value
Type Description
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

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

BytesToSize(Double)

It is used to convert bytes value into kilobytes or megabytes depending on the size based on binary prefix.

Declaration
public Task<string> BytesToSize(double bytes)
Parameters
Type Name Description
System.Double bytes
Returns
Type Description
System.Threading.Tasks.Task<System.String>

Cancel(Object)

Stops the in-progress chunked upload based on the file data. When the file upload is canceled, the partially uploaded file is removed from server.

Declaration
public Task Cancel(object fileData = null)
Parameters
Type Name Description
System.Object fileData
Returns
Type Description
System.Threading.Tasks.Task

ClearAll()

Clear all the file entries from list that can be uploaded files or added in upload queue.

Declaration
public Task ClearAll()
Returns
Type Description
System.Threading.Tasks.Task

CreateFileList(Object, Nullable<Boolean>)

Create the file list for specified files data.

Declaration
public Task CreateFileList(object fileData, Nullable<bool> isSelectedFile = null)
Parameters
Type Name Description
System.Object fileData
System.Nullable<System.Boolean> isSelectedFile
Returns
Type Description
System.Threading.Tasks.Task

CreateJsAdaptor()

Declaration
protected override JSInteropAdaptor CreateJsAdaptor()
Returns
Type Description
Syncfusion.Blazor.Internal.JSInteropAdaptor
Overrides
Syncfusion.Blazor.BaseComponent.CreateJsAdaptor()

GetFilesData(Nullable<Double>)

Get the data of files which are shown in file list.

Declaration
public Task<List<FileInfo>> GetFilesData(Nullable<double> index = null)
Parameters
Type Name Description
System.Nullable<System.Double> index
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<FileInfo>>

GetJSNamespace()

Declaration
public string GetJSNamespace()
Returns
Type Description
System.String

GetModuleName()

Return the module name of the Uploader.

Declaration
public Task<string> GetModuleName()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.BaseComponent.OnAfterRenderAsync(System.Boolean)

OnHybridAfterRender(Boolean)

Declaration
protected Task OnHybridAfterRender(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task

OnHybridInitialized()

Declaration
protected Task OnHybridInitialized()
Returns
Type Description
System.Threading.Tasks.Task

OnHybridParametersSet()

Declaration
protected Task OnHybridParametersSet()
Returns
Type Description
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

Pause(Object, Nullable<Boolean>)

Pauses the in-progress chunked upload based on the file data.

Declaration
public Task Pause(object fileData = null, Nullable<bool> custom = null)
Parameters
Type Name Description
System.Object fileData
System.Nullable<System.Boolean> custom
Returns
Type Description
System.Threading.Tasks.Task

Remove(Object, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object)

Remove the uploaded file from server manually by calling the remove URL action.

If you pass an empty argument to this method, the complete file list can be cleared, otherwise remove the specific file based on its argument ("file_data").

Declaration
public Task Remove(object fileData = null, Nullable<bool> customTemplate = null, Nullable<bool> removeDirectly = null, Nullable<bool> postRawFile = null, object args = null)
Parameters
Type Name Description
System.Object fileData
System.Nullable<System.Boolean> customTemplate
System.Nullable<System.Boolean> removeDirectly
System.Nullable<System.Boolean> postRawFile
System.Object args
Returns
Type Description
System.Threading.Tasks.Task

Resume(Object, Nullable<Boolean>)

Resumes the chunked upload that is previously paused based on the file data.

Declaration
public Task Resume(object fileData = null, Nullable<bool> custom = null)
Parameters
Type Name Description
System.Object fileData
System.Nullable<System.Boolean> custom
Returns
Type Description
System.Threading.Tasks.Task

Retry(Object, Nullable<Boolean>, Nullable<Boolean>)

Retries the canceled or failed file upload based on the file data.

Declaration
public Task Retry(object fileData = null, Nullable<bool> fromcanceledStage = null, Nullable<bool> custom = null)
Parameters
Type Name Description
System.Object fileData
System.Nullable<System.Boolean> fromcanceledStage
System.Nullable<System.Boolean> custom
Returns
Type Description
System.Threading.Tasks.Task

SortFileList(Object)

Allows you to sort the file data alphabetically based on its file name clearly.

Declaration
public Task<List<object>> SortFileList(object filesData = null)
Parameters
Type Name Description
System.Object filesData
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.Object>>

updateChildProperties(String, Object)

Declaration
public void updateChildProperties(string key, object value)
Parameters
Type Name Description
System.String key
System.Object value

Upload(Object, Nullable<Boolean>)

Allows you to call the upload process manually by calling save URL action.

To process the selected files (added in upload queue), pass an empty argument otherwise upload the specific file based on its argument.

Declaration
public Task Upload(object files = null, Nullable<bool> custom = null)
Parameters
Type Name Description
System.Object files
System.Nullable<System.Boolean> custom
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable