Events

This section describes events fired by this widget.

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only when using Knockout.

Main article: onContentReady.

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Main article: onDisposing

See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onInitialized

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget's instance.

fullName

String

The path to the modified option that includes all parent options.

name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.

value any

The modified option's new value.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

progress

Raised when a file segment is uploaded.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
bytesLoaded

Number

The total count of the uploaded bytes.

bytesTotal

Number

The total count of bytes in the XMLHttpRequest.

component

FileUploader

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

file

File

An uploaded file.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

request

XMLHttpRequest Object

An XMLHttpRequest for the file.

segmentSize

Number

The size of the uploaded file segment.

Main article: onProgress

See Also

uploadAborted

Raised when the file upload is aborted.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

file

File

The uploaded file.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

request

XMLHttpRequest Object

Specifies an XMLHttpRequest for the file.

Main article: onUploadAborted

See Also

uploaded

Raised when a file is successfully uploaded.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

file

File

The uploaded file.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

request

XMLHttpRequest Object

Specifies an XMLHttpRequest for the file.

Main article: onUploaded

See Also

uploadError

Raised when an error occurs during the file upload.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

error any

The error that occurred.

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

file

File

An uploaded file.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

request

XMLHttpRequest Object

Specifies an XMLHttpRequest for the file.

Main article: onUploadError

See Also

uploadStarted

Raised when the file upload is started.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

file

File

The uploaded file.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

request

XMLHttpRequest Object

Specifies an XMLHttpRequest for the file.

Main article: onUploadStarted

See Also

valueChanged

Raised when one or several files are added to or removed from the selection.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

FileUploader

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

previousValue

Array<File>

Previously selected files.

value

Array<File>

Newly selected files.

Main article: onValueChanged

See Also