DataTables logo
≡

preUploadCancelled

Since: Editor 1.7.3

Event to indicate if a file upload was cancelled.
Please note - this property requires the Editor extension for DataTables.

Description

This event is triggered if the preUpload event is cancelled by a callback handler. It can be used to unsubscribe any event handlers that might expect the upload to be completed.

The parameters passed to this event handler are identical to those for preUpload.

Type

function( e, fieldName, file, ajaxData )

Parameters:

NameTypeOptional
1e

object

No

Event object

2fieldName

string

No

The name (fields.name) of the field that the file is being uploaded for.

3file

object

No

This object is a File instance for the file that is being uploaded. It contains:

  • lastModified - Epoch milliseconds
  • name - File name
  • size - File size in bytes
  • type - MIME type of the file

Please see the File documentation on MDN for full details of this object.

4ajaxData

object

No

The FormData object that will be used to send information to the server. Additional information can be added, or existing information modified here.

Editor will send the following parameters:

  • action - The action the server is to perform, in this case it will be upload.
  • uploadField - The field name for the file being uploaded
  • upload - The file data from the file object for the upload

Related

The following options are directly related and may also be useful in your application development.

Events