dhtmlXVault API

This API is for Vault v2.5. Please go to docs.dhtmlx.com/vault/ to see API reference for the current version of dhtmlxVault.

Methods
addDraggableNode adds a draggable node to vault
addFileRecord adds a new file record to vault
attachEvent adds any user-defined handler to available events
clear clears the list of files
create creates vault html control on page
detachEvent detaches a handler from an event
disable makes vault inactive
enable makes vault active
getData returns a list of already uploaded files
getFileExtension gets file extension from the filename
getMaxFileSize returns max file size (depending on server settings)
getSLVersion returns version of silverlight if installed
getStatus returns the status of uploading
load loads records from the server
onAddFile called when user has selected a file for uploading
onFileUploaded called after every file is uploaded
onUploadComplete called after all files are uploaded
readableSize converts the file size into readable format
removeDraggableNode removes a draggable node
setAutoRemove immediately removes uploaded file from list (false by default)
setAutoStart immediately start uploading after file added to list (true by default)
setDownloadURL sets the url to the server for downloading files
setFilesLimit controls the number of files allowed to be added to list
setFormField adds or removes custom field
setHeight sets the height of the control parent node
setImagePath sets relative path to the images folder
setMaxFileSize sets a limit for max size of a file to upload
setProgressMode sets the mode of displaying progress status
setSLURL sets the path to the server script file for silverlight mode
setSWFURL sets the path to the server script file for flash mode
setServerHandlers defines server-side handlers for vault
setSizes adjust control size if dimension of parent node was changed
setSkin applies skin to the Vault control
setStrings defines a collection of string resources
setURL sets the path to the server-side script
setWidth sets the width of the control parent node
unload destructor
upload starts uploading
Events
onBeforeClear fires before the user clears the list of files to upload
onBeforeFileAdd fires before the user adds a file to the upload queue
onBeforeFileRemove fires before the user removes a single file from the list of files
onBeforeFileUpload fires before file uploading has started
onClear fires when the user clears the list of files to upload
onDrop fires when the user drops a custom draggable node into the files list
onFileAdd occurs when the user adds a file to the upload queue
onFileRemove fires when the user removes a single file from the list of files
onUploadCancel fires when the user cancels file's uploading
onUploadComplete fires after all files have been uploaded
onUploadFail fires when uploading of the file has failed
onUploadFile fires when a single file from the list was uploaded to the server
Other
$modeName contains the name of the uploading mode
icons icons for files
strings defines a collection of string resources
Back to top