Version

UploadClientEvents Class Members

The following tables list the members exposed by UploadClientEvents.

Public Fields
 NameDescription
Public FieldCancelAllClickedDefines the name of the cancel all button event click. Fired when cancel all button in summary is clicked. Fired only in multiple upload mode. Function takes argument evt and ui. Use ui.owner in order to access the igUpload widget object.  
Public FieldFileExtensionsValidatingIt is fired when validating file extensions. Function takes arguments evt and ui. Use ui.fileName to get the full file name. Use ui.fileExtension to get file extension. Use ui.owner in order to access the igUpload widget object.  
Public FieldFileSelectedDefines the name of the file upload selected event. Fired when file is selected from browse dialog. Return false in order to cancel uploading file. Function takes arguments evt and ui. Use ui.fileId to get unique identifier of the file. Use ui.filePath to get the name of the uploaded file. Use ui.owner in order to access the igUpload widget object.  
Public FieldFileSelectingDefines the name of the file upload selecting event. Fired when browse button is pressed. Return false in order to cancel selecting file. Function takes argument evt.  
Public FieldFileUploadAbortedDefines the name of the file upload cancel event. Fired when the server responses that the file is canceled. Function takes arguments evt and ui. Use ui.fileId to get unique identifier of the file. Use ui.filePath to get the name of the uploaded file. Use ui.totalSize to get the file size of the uploaded file. Use ui.uploadedBytes to get uploaded bytes. Use ui.fileStatus to get current file status. Use ui.owner in order to access the igUpload widget object.  
Public FieldFileUploadedDefines the name of the uploaded event. Fired when the file is uploaded. Function takes arguments evt and ui. Use ui.fileId to get unique identifier of the file. Use ui.filePath to get the name of the uploaded file. Use ui.totalSize to get the file size of the uploaded file. Use ui.owner in order to access the igUpload widget object.  
Public FieldFileUploadingDefines the name of the file uploading event. Fired every time when fileuploader get status for the upload. Return false in order to cancel uploading file. Function takes arguments evt and ui. Use ui.fileId to get unique identifier of the file. Use ui.filePath to get the name of the uploaded file. Use ui.totalSize to get the file size of the uploaded file. Use ui.uploadedBytes to get uploaded bytes. Use ui.fileStatus to get current file status. Use ui.owner in order to access the igUpload widget object.  
Public FieldOnErrorDefines the name of the file upload error event. Fired when error is occurred. Function takes arguments evt and ui. Use ui.errorCode to get current errorCode. Use ui.errorMessage to get detailed error description. Use ui.errorType to get error type - it could be clientside or serverside. Use ui.serverMessage to get specific server message returned by server - if errorType is serverside. Use ui.owner in order to access the igUpload widget object.  
Public FieldOnFormDataSubmitIt is fired before submitting to the server the uploading file(and its additional data if any). It could be used to append additional data fields to the FormData object(if the browser supports HTML5 file API - like newest Chrome, Firefox, IE11+). If the browser does not support HTML5 file API(IE10 and older) it could be added these data fields(as hidden input fields) to the form. Use the public API function addDataFields. Function takes arguments evt and ui. Use ui.fileId to get unique identifier of the file. Use ui.fileInfo to get reference to the fileInfo object - containing information for the fileName, fileSize, serverMessage, etc. Use ui.xhr to get reference to the original XMLHttpRequest object(if the browser supports HTML 5 file API - if not it is undefined). Use ui.formData to get reference to FormData object(if the browser supports HTML5 file API) OR reference to jQuery representation of FORM. Use ui.owner in order to access the igUpload widget object.  
Public FieldOnXHRLoadIt is fired when event onload(of XmlHttpRequest) is fired. This event will be fired only if the browser supports HTML5 file API. Function takes arguments evt and ui. Use ui.fileId to get unique identifier of the file. Use ui.xhr to get reference to the original XMLHttpRequest object. Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from the server-side), etc. Use ui.owner in order to access the igUpload widget object.  
See Also

View on GitHub