JQuery上传插件Uploadify使用详解

目录[-]

Options选项设置

Events事件

Methods方法

Uploadify是JQuery的一个上传插件，实现的效果非常不错，带进度显示。不过官方提供的实例时php版本的，本文将详细介绍Uploadify在Aspnet中的使用，您也可以点击下面的链接进行演示或下载。

官方下载

官方文档

官方演示

?
注：文件包里有两个js分别是：jquery.uploadify.js 和 jquery.uploadify.min.js，两者其实一样，只需载入其中一个js即可。很明显jquery.uploadify.min.js是封装好了的，开发人员推荐使用前者。

Options选项设置

auto：设置为true当选择文件后就直接上传了，为false需要点击上传按钮才上传 。
buttonClass[b]：[/b]给“浏览按钮”加css的class样式
buttonCursor[b]：[/b]鼠标移上去形状：arrow箭头、hand手型（默认）
buttonImage[b]：[/b]浏览按钮的图片的路径 ，鼠标移上去变换图片
buttonText[b]：[/b]浏览按钮的文本，默认值：BROWSE 。
[b]checkScript ：[/b]用来判断上传选择的文件在服务器是否存在的后台处理程序的相对路径
checkExisting[b]：[/b]在目录中检查文件是否已上传成功（1 ture,0 false）
[b]cancelImg ：[/b]选择文件到文件队列中后的每一个文件上的关闭按钮图标，如下图：



debug[b]：[/b]是否显示调试框（默认不显示false）
[b]folder ： [/b] 上传文件存放的目录 。
[b]fileDesc ：[/b] 这个属性值必须设置fileExt属性后才有效，用来设置选择文件对话框中的提示文本，如设置fileDesc为“请选择rar doc pdf文件”，打开文件选择框效果如下图：



[b]fileExt ： [/b]设置可以选择的文件的类型，格式如：'*.doc;*.pdf;*.rar' 。
[b]fileDataName ：[/b]设置一个名字，在服务器处理程序中根据该名字来取上传文件的数据。默认为Filedata
fileObjName[b]：[/b]设置一个名字，在服务器处理程序中根据该名字来取上传文件的数据。默认为Filedata，$tempFile = $_FILES['Filedata']['tmp_name']
fileSizeLimit[b]：[/b]设置允许上传文件最大值B, KB, MB, GB 比如：'fileSizeLimit' : '20MB'
fileTypeDesc[b]：[/b]选择的文件的描述。这个字符串出现在浏览文件对话框中文件类型下拉框处。默认：All Files
fileTypeExts[b]：[/b]允许上传的文件类型。格式：'fileTypeExts' : '*.gif; *.jpg; *.png'
formData[b]：[/b]附带值，需要通过get or post传递的额外数据，需要结合onUploadStart事件一起使用
height[b]： [/b]设置“浏览按钮”高度px ，默认值：30。
[b]hideButton ：[/b] 设置为true则隐藏浏览按钮的图片 。
itemTemplate[b]：[/b]<itemTemplate>节点表示显示的内容。这些内容中也可以包含绑定到控件DataSource属性中元素集合的数据。
method[b]：[/b]提交方式Post 或Get 默认为Post
multi[b]：[/b]选择文件时是否可以【选择多个】。默认：可以true
overrideEvents[b]：[/b]不执行默认的onSelect事件
preventCaching[b]：[/b]随机缓存值 默认true ，可选true和false.如果选true,那么在上传时会加入一个随机数来使每次的URL都不同,以防止缓存.但是可能与正常URL产生冲突
progressData[b]：[/b]进度条上显示的进度:有百分比percentage和速度speed。默认百分比
queueID[b]：[/b]文件队列的ID，该ID与存放文件队列的div的ID一致。给“进度条”加背景css的ID样式。文件选择后的容器ID
queueSizeLimit[b]：[/b]当允许多文件生成时，设置选择文件的个数，默认值：999 。
removeCompleted[b]：[/b]上传完成后队列是否自动消失。默认：true
removeTimeout[b]：[/b]上传完成后队列多长时间后消失。默认 3秒 需要：'removeCompleted' : true,时使用
requeueErrors[b]：[/b]队列上传出错，是否继续回滚队列，即反复尝试上传。默认：false
[b]rollover ：[/b] 值为true和false，设置为true时当鼠标移到浏览按钮上时有反转效果。
[b]sizeLimit ：[/b] 上传文件的大小限制 。
[b]simUploadLimit ： [/b]允许同时上传的个数 默认值：1 。
[b]scriptAccess ：[/b]flash脚本文件的访问模式，如果在本地测试设置为always，默认值：sameDomain
[b]script ：[/b] 后台处理程序的相对路径 。默认值：uploadify.php
successTimeout：上传超时时间。文件上传完成后,等待服务器返回信息的时间(秒).超过时间没有返回的话,插件认为返回了成功。 默认：30秒
swf[b]：[/b]swf文件的路径,本文件是插件自带的,不可用其它的代替.本参数不可省略
uploader[b]：[/b]uploadify.swf 文件的相对路径，该swf文件是一个带有文字BROWSE的按钮，点击后淡出打开文件对话框，默认值：uploadify.swf。
uploadLimit[b]：[/b]限制总上传文件数,默认是999。指同一时间，如果关闭浏览器后重新打开又可上传。
width [b]：[/b]设置“浏览按钮”宽度px ，默认值：110。
[b]wmode ：[/b] 设置该项为transparent 可以使浏览按钮的flash背景文件透明，并且flash文件会被置为页面的最高层。 默认值：opaque 。

[b]Events事件[/b]

onInit : 每次初始化一个队列时触发,做一些初始化的工作。

?
onSelect ：当文件从浏览框被添加到队列中时触发.选择文件时触发，该函数有三个参数

event:事件对象。

queueID：文件的唯一标识，由6为随机字符组成。

fileObj：选择的文件对象，有name、size、creationDate、modificationDate、type 5个属性。

代码如下：


?
当选择一个文件后弹出的消息如下图：





onSelectOnce ：在单文件或多文件上传时，选择文件时触发。该函数有两个参数event，data，data对象有以下几个属性：

fileCount：选择文件的总数。

filesSelected：同时选择文件的个数，如果一次选择了3个文件该属性值为3。

filesReplaced：如果文件队列中已经存在A和B两个文件，再次选择文件时又选择了A和B，该属性值为2。

allBytesTotal：所有选择的文件的总大小。

onCancel : 当点击文件队列中文件的关闭按钮或点击取消上传时触发。该函数有event、queueId、fileObj、data四个参数，前三个参数同onSelect 中的三个参数，data对象有两个属性fileCount和allBytesTotal。

fileCount：取消一个文件后，文件队列中剩余文件的个数。

allBytesTotal：取消一个文件后，文件队列中剩余文件的大小。

onClearQueue ：清除队列。当'cancel'方法带着*参数时,也就是说一次全部取消的时候触发.queueItemCount是被取消的文件个数（另外的按钮）.当调用函数fileUploadClearQueue时触发。有event和data两个参数，同onCancel 中的两个对应参数。

onQueueFull ：当设置了queueSizeLimit并且选择的文件个数超出了queueSizeLimit的值时触发。该函数有两个参数event和queueSizeLimit。

onError ：当上传过程中发生错误时触发。该函数有event、queueId、fileObj、errorObj四个参数，其中前三个参数同上，errorObj对象有type和info两个属性。

type：错误的类型，有三种‘HTTP’, ‘IO’, or ‘Security’

info：错误的描述

onOpen ：点击上传时触发，如果auto设置为true则是选择文件时触发，如果有多个文件上传则遍历整个文件队列。该函数有event、queueId、fileObj三个参数，参数的解释同上。

onProgress ：点击上传时触发，如果auto设置为true则是选择文件时触发，如果有多个文件上传则遍历整个文件队列，在onOpen之后触发。该函数有event、queueId、fileObj、data四个参数，前三个参数的解释同上。data对象有四个属性percentage、bytesLoaded、allBytesLoaded、speed：

percentage：当前完成的百分比

bytesLoaded：当前上传的大小

allBytesLoaded：文件队列中已经上传完的大小

speed：上传速率 kb/s

onComplete：文件上传完成后触发。该函数有四个参数event、queueId、fileObj、response、data五个参数，前三个参数同上。response为后台处理程序返回的值，在上面的例子中为1或0，data有两个属性fileCount和speed

fileCount：剩余没有上传完成的文件的个数。

speed：文件上传的平均速率 kb/s

注：fileObj对象和上面讲到的有些不太一样，onComplete 的fileObj对象有个filePath属性可以取出上传文件的路径。

onAllComplete：文件队列中所有的文件上传完成后触发。该函数有event和data两个参数，data有四个属性，分别为：

filesUploaded :上传的所有文件个数。

errors ：出现错误的个数。

allBytesLoaded ：所有上传文件的总大小。

speed ：平均上传速率 kb/s

onDestroy：取消所有的上传队列（另外的按钮）

onDialogClose[b]：当选择文件对话框关闭时触发,不论是点的'确定'还是'取消'都会触发.如果本事件被添加进了'overrideEvents'参数中,那么如果在选择文件时产生了错误,不会有错误提示框弹出
[/b]

onDialogOpen[b]：当选择文件框被打开时触发,没有传过来的参数
[/b]

onEnable[b]：开启上传
[/b]

onDisable[b]：关闭上传
[/b]

onFallback[b]：检测FLASH失败调用
[/b]

onQueueComplete[b]：当队列中的所有文件上传完成时触发
[/b]

onSelectError[b]：选择文件出错时触发
[/b]

onSWFReady[b]：flash准备好时触发
[/b]

onUploadComplete[b]：当一个文件上传完成时触发
[/b]

onUploadError[b]：当文件上传完成但是返回错误时触发
[/b]

onUploadProgress[b]：上传汇总[/b]

[b]onUploadStart[b]：一个文件上传之间触发（[/b]动态改变参数的值，此方法很重要，当在多文件跨服务器上传时，你要给每个文件赋值不同的OnlyKey，即修改formData数据，服务器上的文件和数据库的OnlyKey一致，必须用到此方法）
[/b]

onUploadSuccess[b]：每个上传完成并成功的文件都会触发本事件[/b]

[b]uploadifySettings：可以动态修改上面介绍的那些key值，如下面代码
[/b]

?
如果上传按钮的事件写成下面这样，文件将会上传到uploadifySettings定义的目录中

?
[b]uploadifyCancel：该函数接受一个queueID作为参数，可以取消文件队列中指定queueID的文件。[/b]

?

[b]Methods方法[/b]

cancel：取消一个上传队列

destroy：取消所有上传队列
disable：禁止点击“浏览按钮”
settings：返回或修改一个 uploadify实例的settings值
stop：停止当前的上传并重新添加到队列中去
upload：上传指定的文件或者所有队列中的文件

uploadify多文件上传例子：

?