Skip to main content

FileUploaderBuilder Methods

A FileUploader control.
Name Description
AbortUpload(RazorBlock) A function that cancels the file upload. Mirrors the client-side abortUpload option.
AbortUpload(String) A function that cancels the file upload. Mirrors the client-side abortUpload option.
Accept(JS) Specifies a file type or several types accepted by the UI component. Mirrors the client-side accept option.
Accept(String) Specifies a file type or several types accepted by the UI component. Mirrors the client-side accept option.
AccessKey(JS) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
AccessKey(String) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
ActiveStateEnabled(JS) Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option.
ActiveStateEnabled(Boolean) Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option.
AllowCanceling(JS) Specifies if an end user can remove a file from the selection and interrupt uploading. Mirrors the client-side allowCanceling option.
AllowCanceling(Boolean) Specifies if an end user can remove a file from the selection and interrupt uploading. Mirrors the client-side allowCanceling option.
AllowedFileExtensions(JS) Restricts file extensions that can be uploaded to the server. Mirrors the client-side allowedFileExtensions option.
AllowedFileExtensions(IEnumerable<String>) Restricts file extensions that can be uploaded to the server. Mirrors the client-side allowedFileExtensions option.
ChunkSize(JS) Specifies the chunk size in bytes. Applies only if uploadMode is 'instantly' or 'useButtons'. Requires a server that can process file chunks. Mirrors the client-side chunkSize option.
ChunkSize(Double) Specifies the chunk size in bytes. Applies only if uploadMode is 'instantly' or 'useButtons'. Requires a server that can process file chunks. Mirrors the client-side chunkSize option.
DialogTrigger(JS) Specifies the HTML element which invokes the file upload dialog. Mirrors the client-side dialogTrigger option.
DialogTrigger(String) Specifies the HTML element which invokes the file upload dialog. Mirrors the client-side dialogTrigger option.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
DropZone(JS) Specifies the HTML element in which users can drag and drop files for upload. Mirrors the client-side dropZone option.
DropZone(String) Specifies the HTML element in which users can drag and drop files for upload. Mirrors the client-side dropZone option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FocusStateEnabled(JS) Mirrors the client-side focusStateEnabled option.
FocusStateEnabled(Boolean) Mirrors the client-side focusStateEnabled option.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
Height(JS) Specifies the UI component's height. Mirrors the client-side height option.
Height(Double) Specifies the UI component's height. Mirrors the client-side height option.
Height(String) Specifies the UI component's height. Mirrors the client-side height option.
Hint(JS) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
Hint(String) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
HoverStateEnabled(JS) Specifies whether the FileUploader component changes the state of all its buttons when users hover over them. Mirrors the client-side hoverStateEnabled option.
HoverStateEnabled(Boolean) Specifies whether the FileUploader component changes the state of all its buttons when users hover over them. Mirrors the client-side hoverStateEnabled option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
InputAttr(JS) Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
InputAttr(Dictionary<String, Object>) Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
InputAttr(Object) Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
InputAttr(String, Object) Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
InvalidFileExtensionMessage(JS) The text displayed when the extension of the file being uploaded is not an allowed file extension. Mirrors the client-side invalidFileExtensionMessage option.
InvalidFileExtensionMessage(String) The text displayed when the extension of the file being uploaded is not an allowed file extension. Mirrors the client-side invalidFileExtensionMessage option.
InvalidMaxFileSizeMessage(JS) The text displayed when the size of the file being uploaded is greater than the maxFileSize. Mirrors the client-side invalidMaxFileSizeMessage option.
InvalidMaxFileSizeMessage(String) The text displayed when the size of the file being uploaded is greater than the maxFileSize. Mirrors the client-side invalidMaxFileSizeMessage option.
InvalidMinFileSizeMessage(JS) The text displayed when the size of the file being uploaded is less than the minFileSize. Mirrors the client-side invalidMinFileSizeMessage option.
InvalidMinFileSizeMessage(String) The text displayed when the size of the file being uploaded is less than the minFileSize. Mirrors the client-side invalidMinFileSizeMessage option.
IsDirty(JS)
IsDirty(Boolean)
IsValid(JS) Mirrors the client-side isValid option.
IsValid(Boolean) Mirrors the client-side isValid option.
LabelText(JS) Specifies the text displayed on the area to which an end user can drop a file. Mirrors the client-side labelText option.
LabelText(String) Specifies the text displayed on the area to which an end user can drop a file. Mirrors the client-side labelText option.
MaxFileSize(JS) Specifies the maximum file size (in bytes) allowed for uploading. Applies only if uploadMode is 'instantly' or 'useButtons'. Mirrors the client-side maxFileSize option.
MaxFileSize(Double) Specifies the maximum file size (in bytes) allowed for uploading. Applies only if uploadMode is 'instantly' or 'useButtons'. Mirrors the client-side maxFileSize option.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MinFileSize(JS) Specifies the minimum file size (in bytes) allowed for uploading. Applies only if uploadMode is 'instantly' or 'useButtons'. Mirrors the client-side minFileSize option.
MinFileSize(Double) Specifies the minimum file size (in bytes) allowed for uploading. Applies only if uploadMode is 'instantly' or 'useButtons'. Mirrors the client-side minFileSize option.
Multiple(JS) Specifies whether the UI component enables an end user to select a single file or multiple files. Mirrors the client-side multiple option.
Multiple(Boolean) Specifies whether the UI component enables an end user to select a single file or multiple files. Mirrors the client-side multiple option.
Name(JS) Specifies the value passed to the name attribute of the underlying input element. Required to access uploaded files on the server. Mirrors the client-side name option.
Name(String) Specifies the value passed to the name attribute of the underlying input element. Required to access uploaded files on the server. Mirrors the client-side name option.
OnBeforeSend(RazorBlock) A function that allows you to customize the request before it is sent to the server. Mirrors the client-side onBeforeSend option.
OnBeforeSend(String) A function that allows you to customize the request before it is sent to the server. Mirrors the client-side onBeforeSend option.
OnContentReady(RazorBlock) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnContentReady(String) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDropZoneEnter(RazorBlock) A function that is executed when the mouse enters a drop zone while dragging a file. Mirrors the client-side onDropZoneEnter option.
OnDropZoneEnter(String) A function that is executed when the mouse enters a drop zone while dragging a file. Mirrors the client-side onDropZoneEnter option.
OnDropZoneLeave(RazorBlock) A function that is executed when the mouse leaves a drop zone as it drags a file. Mirrors the client-side onDropZoneLeave option.
OnDropZoneLeave(String) A function that is executed when the mouse leaves a drop zone as it drags a file. Mirrors the client-side onDropZoneLeave option.
OnFilesUploaded(RazorBlock) A function that is executed when the file upload process is complete. Mirrors the client-side onFilesUploaded option.
OnFilesUploaded(String) A function that is executed when the file upload process is complete. Mirrors the client-side onFilesUploaded option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnProgress(RazorBlock) A function that is executed when a file segment is uploaded. Mirrors the client-side onProgress option.
OnProgress(String) A function that is executed when a file segment is uploaded. Mirrors the client-side onProgress option.
OnUploadAborted(RazorBlock) A function that is executed when the file upload is aborted. Mirrors the client-side onUploadAborted option.
OnUploadAborted(String) A function that is executed when the file upload is aborted. Mirrors the client-side onUploadAborted option.
OnUploaded(RazorBlock) A function that is executed when a file is successfully uploaded. Mirrors the client-side onUploaded option.
OnUploaded(String) A function that is executed when a file is successfully uploaded. Mirrors the client-side onUploaded option.
OnUploadError(RazorBlock) A function that is executed when an error occurs during the file upload. Mirrors the client-side onUploadError option.
OnUploadError(String) A function that is executed when an error occurs during the file upload. Mirrors the client-side onUploadError option.
OnUploadStarted(RazorBlock) A function that is executed when the file upload is started. Mirrors the client-side onUploadStarted option.
OnUploadStarted(String) A function that is executed when the file upload is started. Mirrors the client-side onUploadStarted option.
OnValueChanged(RazorBlock) A function that is executed when one or several files are added to or removed from the selection. Mirrors the client-side onValueChanged option.
OnValueChanged(String) A function that is executed when one or several files are added to or removed from the selection. Mirrors the client-side onValueChanged option.
Option(String, Object) Specifies an option by its name.
Progress(JS) Gets the current progress in percentages. Mirrors the client-side progress option.
Progress(Double) Gets the current progress in percentages. Mirrors the client-side progress option.
ReadOnly(JS) Mirrors the client-side readOnly option.
ReadOnly(Boolean) Mirrors the client-side readOnly option.
ReadyToUploadMessage(JS) The message displayed by the UI component when it is ready to upload the specified files. Mirrors the client-side readyToUploadMessage option.
ReadyToUploadMessage(String) The message displayed by the UI component when it is ready to upload the specified files. Mirrors the client-side readyToUploadMessage option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
SelectButtonText(JS) The text displayed on the button that opens the file browser. Mirrors the client-side selectButtonText option.
SelectButtonText(String) The text displayed on the button that opens the file browser. Mirrors the client-side selectButtonText option.
ShowFileList(JS) Specifies whether or not the UI component displays the list of selected files. Mirrors the client-side showFileList option.
ShowFileList(Boolean) Specifies whether or not the UI component displays the list of selected files. Mirrors the client-side showFileList option.
TabIndex(JS) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
TabIndex(Int32) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
UploadAbortedMessage(JS) The message displayed by the UI component when the file upload is cancelled. Mirrors the client-side uploadAbortedMessage option.
UploadAbortedMessage(String) The message displayed by the UI component when the file upload is cancelled. Mirrors the client-side uploadAbortedMessage option.
UploadButtonText(JS) The text displayed on the button that starts uploading. Mirrors the client-side uploadButtonText option.
UploadButtonText(String) The text displayed on the button that starts uploading. Mirrors the client-side uploadButtonText option.
UploadChunk(RazorBlock) A function that uploads a file in chunks. Mirrors the client-side uploadChunk option.
UploadChunk(String) A function that uploads a file in chunks. Mirrors the client-side uploadChunk option.
UploadCustomData(Object) Specifies custom data for the upload request. Mirrors the client-side uploadCustomData option.
UploadedMessage(JS) The message displayed by the UI component when uploading is finished. Mirrors the client-side uploadedMessage option.
UploadedMessage(String) The message displayed by the UI component when uploading is finished. Mirrors the client-side uploadedMessage option.
UploadFailedMessage(JS) The message displayed by the UI component on uploading failure. Mirrors the client-side uploadFailedMessage option.
UploadFailedMessage(String) The message displayed by the UI component on uploading failure. Mirrors the client-side uploadFailedMessage option.
UploadFile(RazorBlock) A function that uploads a file. Mirrors the client-side uploadFile option.
UploadFile(String) A function that uploads a file. Mirrors the client-side uploadFile option.
UploadHeaders(Object) Specifies headers for the upload request. Mirrors the client-side uploadHeaders option.
UploadMethod(UploadHttpMethod) Specifies the method for the upload request. Mirrors the client-side uploadMethod option.
UploadMode(FileUploadMode) Specifies how the UI component uploads files. Mirrors the client-side uploadMode option.
UploadUrl(JS) Specifies a target Url for the upload request. Mirrors the client-side uploadUrl option.
UploadUrl(String) Specifies a target Url for the upload request. Mirrors the client-side uploadUrl option.
ValidationError(Object) Information on the broken validation rule. Contains the first item from the validationErrors array. Mirrors the client-side validationError option.
ValidationErrors(JS) An array of the validation rules that failed. Mirrors the client-side validationErrors option.
ValidationErrors(IEnumerable) An array of the validation rules that failed. Mirrors the client-side validationErrors option.
ValidationStatus(ValidationStatus) Indicates or specifies the current validation status. Mirrors the client-side validationStatus option.
Value(JS) Specifies a File instance representing the selected file. Read-only when uploadMode is 'useForm'. Mirrors the client-side value option.
Value(IEnumerable) Specifies a File instance representing the selected file. Read-only when uploadMode is 'useForm'. Mirrors the client-side value option.
Visible(JS) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Visible(Boolean) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Width(JS) Specifies the UI component's width. Mirrors the client-side width option.
Width(Double) Specifies the UI component's width. Mirrors the client-side width option.
Width(String) Specifies the UI component's width. Mirrors the client-side width option.
See Also