kw.File Class

Members

kw.File (Object)

Constructs and returns the File represented by the specified settings object. This method is only intended to be called internally by SlickUpload.

Setting Attributes

• fileObject (Object) – The actual browser DOM object that contains the file data.
• fileSelector (kw.FileSelector) – The FileSelector that selected this File.
• id (String) – A unique id that identifies this file.
• onFileUpdated (Function) – A function to connect to the FileUpdated event.

add_FileUpdated(Function)

Adds a handler for the FileUpdated event. This event is triggered whenever information about the file is updated.

Parameters

• handler (Function) – The handler function to add. The function will be passed the kw.File that was updated.

getElementById (String)

Returns a DOM element matching the specified id within the file list item for this file, or null if no matching element was found. The specified id will be prefixed by the unique id prepended to file list item id's.

Parameters

• id (String) – The id of the DOM element to retrieve.

Return Value

• element – The DOM element, or null if none was found.

get_Extension()

Returns the file extension of this File.

Return Value

• String – The file extension of this File.

get_FileObject()

Returns the actual browser DOM object that contains the file data.

Return Value

• Object – The actual browser DOM object that contains the file data.

get_FileSelector()

Returns the FileSelector that selected this File.

Return Value

• kw.FileSelector – The FileSelector that selected this File.

get_Id()

Returns the id of this File.

Return Value

• String – The id of this File.

get_IsCancelled()

Returns a boolean that specifies whether this File was cancelled during upload.

Return Value

• Boolean – Indicates whether this File was cancelled during upload.

get_IsErrored()

Returns a boolean that specifies whether this File generated an error during upload.

Return Value

• Boolean – Indicates whether this File generated an error during upload.

get_IsExtensionValid()

Returns a boolean that specifies whether this File has a valid extension.

Return Value

• Boolean – Indicates whether this File has a valid extension.

get_IsSizeValid()

Returns a boolean that specifies whether this File has a valid size.

Return Value

• Boolean – Indicates whether this File has a valid size.

get_IsValid()

Returns a boolean that specifies whether this File is valid.

Return Value

• Boolean – Indicates whether this File is valid.

get_Name()

Returns the filename of this File.

Return Value

• String – The filename of this File.

get_Size()

Returns the size of this File, or null if the size has not yet been calculated.

Return Value

• Number – The size of this File, or null if the size has not yet been calculated.