Ultimate Uploader v1.4
JavaScript API |
Javascript API General
Ultimate Uploader provides advanced support of JavaScript API, allowing to command the component from host web page and react to the events occuring during upload process.
Note! The client browser may not support JavaScript or it can be disabled in user browser settings. Therefore it is strongly recommended to consider it at usage JavaScript API placing appropriate messages to the user in tag <noscript>.
The object giving possibility of JavaScript management and event handling is accessed as follows:
var uploadController = document.getElementById("ultimateUploader").Content.JSAPI;
where "ultimateUploader" is an id of the <object> tag representing the Silverlight module on the web page.
It is recommended to get controller object in the function defining in "onLoad" parameter of the <oblect> tag. For example:
<object id="ultimateUploader" data="data:application/x-silverlight-2," ... ... <param name="onLoad" value="onSilverlightLoaded" /> ... </object> <script type="text/javascript"> function onSilverlightLoaded() { var uploadController = document.getElementById("ultimateUploader").Content.JSAPI; ... } </script>
Setting upload parameters
It is possible to set upload control parameters at any time via properties as shown below:
<script type="text/javascript"> function onSilverlightLoaded() { var uploadController = document.getElementById("ultimateUploader").Content.JSAPI; uploadController.UploadHandler = "upload.php"; uploadController.FileTypesFilter = "Jpeg images (*.jpg)|*.jpg"; uploadController.ShowHelpButton = false; uploadController.AvailableView = 1; uploadController.UploadThumbnails = true; uploadController.ThumbnailSize = 256; } </script>
For complete list of properties see JavaScript API Reference.
Handling events occuring during upload process
Ultimate Uploader raises events at start, pause, cancel and completion of upload each file and whole upload process. Example handling file upload completion event:
<script type="text/javascript"> function onSilverlightLoaded() { var uploadController = document.getElementById("ultimateUploader").Content.JSAPI; uploadController.UploadFileCompleted = MyFileCompleteHandler; } function MyFileCompleteHandler(sender, args) { alert("Complete upload file " + args.FileName + ", size " + args.FileSize + " bytes." + "\nServer response: " + args.ServerResponse + "\nFile comment: " + args.FileComment + "\nTag: " + args.Tag); } </script>
For complete list of events and event arguments see JavaScript API Reference.
Sending commands to upload control
Ultimate Uploader supports methods which you can use in JavaScript code for start, pause and cancel upload process. Example using custom start and stop command controls instead of standard buttons:
<object id="ultimateUploader" data="data:application/x-silverlight-2," ... ... <param name="initParams" value="...ShowUploadButton=false,ShowCancelButton=false..." /> ... </object>t> <button type="button" onclick="Start()">Start</button> <button type="button" onclick="Stop()">Stop</button> <script type="text/javascript"> function Start() { document.getElementById("ultimateUploader").Content.JSAPI.StartUpload(); } function Stop() { document.getElementById("ultimateUploader").Content.JSAPI.StopUpload(); } </script>
For complete information about methods see JavaScript API Reference.
ASP.NET control specificities
In case of use ASP.NET control JavaScript API usage becomes much simpler as a result of automatic generation of auxiliary javascript functions. You only need to make the following: