List of properties
Property name | Description |
---|---|
length | The count of files that are being contained now in the upload queue. |
fileNamePattern | The pattern that is used for the name column in the TableView user interface and for the column in the ListView interface. |
fileFormFieldName | The field name that precedes the file data in the upload POST operation. |
filteredFileSelection | Defines whether all selected files should be rejected if at least one of them doesn't conform to defined limitations. |
allowedExtensions | An array of file filter objects that are used to indicate what files on the user's system are shown in the file-browsing dialog box. |
filesCountLimit | Indicates the maximum count of files which can be added to the upload queue. |
allowMultipleSelection | Determines whether browse dialog will allow multiple selection. |
renewQueueAfterSelection | Determines whether queue should be cleared after new files have been selected. |
fileSizeLimit | Indicates the maximum size(in bytes) of each file that can be added to the upload queue. |
totalSizeLimit | Indicates the maximum size(in bytes) of all files that can be added to the upload queue. |
totalSize | The total size(in bytes) of files that are being contained now in the upload queue. |
totalSizeString | The formatted string of totalSize property value. |
filesCountLimitMsg | The text of message that is generated when the count of selcted files exceeds allowed limit. |
fileSizeLimitMsg | The text of message that is generated when the size of at least one of selcted files exceeds allowed limit. |
totalSizeLimitMsg | The text of message that is generated when total size of selected files exceeds allowed limit. |
fileTypeRestrictionMsg | The text of message that is generated when at least one of selcted files has unallowed extension. |
rejectedFilesCount | The count of files that were rejected by a defined policy after one selection operation. |
deleteUploadedFiles | Indicates whether uploaded files should be automatically deleted from the queue. |
length (Read only)
Default value: none
Type: int
String reference: "queue.length"
Description:
The count of files that are being contained now in the upload queue.
Examples:
The value of property is got via getProperty method of EAFlashUpload JavaScript API:
EAFlashUpload.getProperty("queue.length");
fileNamePattern
Default value: "#FILE_NAME#"
Type: string
String reference: "queue.fileNamePattern"
Description:
The string pattern that is used as a value of name column of the TableView and ListView interface. This property provides a possibility to add some additional information such as size or midification date to the file name and display this value for the user. The property supports formatting constants, see String formatting for more information.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.fileNamePattern"] = "#FILE_NAME# (#FILE_SIZE#)";
fileFormFieldName
Default value: "Filedata"
Type: string
String reference: "queue.fileFormFieldName"
Description:
The field name that precedes the file data in the upload POST operation. The fileFormFieldName value must be a non-empty string. By default, the value of fileFormFieldName is "Filedata", as shown in the following sample POST request:
Content-Type: multipart/form-data; boundary=AaB03x --AaB03x Content-Disposition: form-data; name="Filedata"; filename="example.jpg" Content-Type: application/octet-stream ... contents of example.jpg ... --AaB03x--
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.fileFormFieldName"] = "Filedata";
filteredFileSelection
Default value: true
Type: Boolean
String reference: "queue.filteredFileSelection"
Description:
Defines whether all selected files should be rejected if at least one of them doesn't conform to defined limitations. If property is set to "true" then the files are conform to existing limitation are added to the queue, otherwise all files is rejected.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.filteredFileSelection"] = true;
allowedExtensions
Default value: ["All files:*.*"]
Type: Array
String reference: "queue.allowedExtensions"
Description:
An array of file filter objects that are used to indicate what files on the user's system are shown in the file-browsing dialog box.
The file filter object has the following structure:
<Description>:<Extension>
- Description - The description string for the filter. The description is visible to the user in the dialog box. The description string contains a string, such as "Images (*.gif, *.jpg, *.png)", that can help instruct the user on what file types can be uploaded. Note that the actual file types that are allowed for selection are stored in the extension part.
- Extension - A list of file extensions. This list indicates the types of files that you want to show in the file-browsing dialog box. (The list is not visible to the user; the user sees only the value of the description part.) The extension property contains a semicolon-delimited list of Windows file extensions, with a wildcard (*) preceding each extension, as shown in the following string: "*.jpg;*.gif;*.png".
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.allowedExtensions"] = "All files:*.*|Images (*.gif, *.jpg, *.png):*.jpg;*.gif;*.png";
filesCountLimit
Default value: 0 (unlimited)
Type: int
String reference: "queue.filesCountLimit"
Description:
Indicates the maximum count of files wich can be added to the upload queue. If filteredFileSelection property is set to "true" and count of queue items are lower than allowed limit then when you try to add new files only part of files is added to the queue and other files is rejected. If filteredFileSelection is set to "false" and count of selected files plus count of existed in the queue files greater than allowed limit then all files is rejected.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.filesCountLimit"] = 0;
allowMultipleSelection
Default value: true
Type: Boolean
String reference: "queue.allowMultipleSelection"
Description:
Determines whether browse dialog will allow multiple selection. This property may be useful if you want to limit users to choose files one by one. If filesCountLimit property is defined as 1 then renewQueueAfterSelection is switched to true and allowMultipleSelection property is switched to false automatically.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.allowMultipleSelection"] = true;
renewQueueAfterSelection
Default value: false. "true" if ShortView UI is used.
Type: Boolean
String reference: "queue.renewQueueAfterSelection"
Description:
Determines whether queue should be cleared after new files have been selected. If property is defined as true then queue is cleared before adding new selected files. If filesCountLimit property is defined as 1 then renewQueueAfterSelection is switched to true and allowMultipleSelection property is switched to false automatically.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.renewQueueAfterSelection"] = true;
fileSizeLimit
Default value: 0 (unlimited)
Type: int
String reference: "queue.fileSizeLimit"
Description:
Indicates a maximum size(in bytes) of each file that can be added to the upload queue. If filteredFileSelection property is set to "true" then when you try to add new files only files with allowed size is added to the queue and other files is rejected. If filteredFileSelection is set to "false" and at least one of files doesn't conform to allowed limit then all files is rejected.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.fileSizeLimit"] = 0;
totalSizeLimit
Default value: 0 (unlimited)
Type:
String reference: "queue.totalSizeLimit"
Description:
Indicates the maximum size(in bytes) of all files that can be added to the upload queue. If filteredFileSelection property is set to "true" and size of all files in the queue are lower than allowed limit then new files are being added while general size does not exceed the allowed limit. If filteredFileSelection is set to "false" and size of selected files plus size of existed in the queue files are greater than allowed limit then all files is rejected.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.totalSizeLimit"] = 0;
totalSize (Read only)
Default value: none
Type: int
String reference: "queue.totalSize"
Description:
The total size(in bytes) of files that are being contained now in the upload queue.
Examples:
The value of property is got via getProperty method of EAFlashUpload JavaScript API:
EAFlashUpload.getProperty("queue.totalSize");
totalSizeString (Read only)
Default value: none
Type: string
String reference: "queue.totalSizeString"
Description:
The string contains formatted value of totalSize property. The formatting bases on sizeAbbrev property.
Examples:
The value of property is got via getProperty method of EAFlashUpload JavaScript API:
EAFlashUpload.getProperty("queue.totalSizeString");
filesCountLimitMsg
Default value: "Files count limit(#FILES_COUNT_LIMIT#) exceeded! #REJ_FILES_COUNT# files has been rejected."
Type: string
String reference: "queue.filesCountLimitMsg"
Description:
The text of message that is generated when the count of selcted files exceeds allowed limit. The mentioned message is displayed in an alert dialog of the user interface and is returned as a parameter of JavaScript error event handler on the page. The property supports formatting constants, see String formatting for more information.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.filesCountLimitMsg"] = "Files count limit(#FILES_COUNT_LIMIT#) exceeded!";
fileSizeLimitMsg
Default value: "Maximum file size(#FILE_SIZE_LIMIT#) exceeded! #REJ_FILES_COUNT# files has been rejected."
Type: string
String reference: "queue.fileSizeLimitMsg"
Description:
The text of message that is generated when the size of at least one of selcted files exceeds allowed limit. The mentioned message is displayed in an alert dialog of the user interface and is returned as a parameter of JavaScript error event handler on the page. The property supports formatting constants, see String formatting for more information.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.fileSizeLimitMsg"] = "Maximum file size(#FILE_SIZE_LIMIT#) exceeded!";
totalSizeLimitMsg
Default value: "Total size limit(#TOTAL_FILES_SIZE_LIMIT#) exceeded! #REJ_FILES_COUNT# files has been rejected."
Type: string
String reference: "queue.totalSizeLimitMsg"
Description:
The text of message that is generated when total size of selected files exceeds allowed limit. The mentioned message is displayed in an alert dialog of the user interface and is returned as a parameter of JavaScript error event handler on the page. The property supports formatting constants, see String formatting for more information.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.totalSizeLimitMsg"] = "Total size limit(#TOTAL_FILES_SIZE_LIMIT#) exceeded!";
fileTypeRestrictionMsg
Default value: "There are files with unallowed type! #REJ_FILES_COUNT# files has been rejected."
Type: string
String reference: "queue.fileTypeRestrictionMsg"
Description:
The text of message that is generated when at least one of selcted files has an unallowed extension. The mentioned message is displayed in an alert dialog of the user interface and is returned as a parameter of JavaScript error event handler on the page. The property supports formatting constants, see String formatting for more information.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.fileTypeRestrictionMsg"] = There are files with unallowed type! #REJ_FILES_COUNT# files has been rejected.;
rejectedFilesCount (Read only)
Default value: none
Type: int
String reference: "queue.rejectedFilesCount"
Description:
The count of files that were rejected by a defined policy after one selection operation. The value of property is renewed after each files addition. See also filteredFileSelection property.
Examples:
The value of property is got via getProperty method of EAFlashUpload JavaScript API:
EAFlashUpload.getProperty("queue.rejectedFilesCount");
deleteUploadedFiles
Default value: false
Type: Boolean
String reference: "queue.deleteUploadedFiles"
Description:
Indicates whether uploaded files should be automatically deleted from the queue. "true" if uploaded files should be deleted, otherwise "false". The files are automatically deleted after successful upload only. If the user will press a "Cancel" button or upload will be stopped by JavaScript API then files will not be deleted regardless of property value.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["queue.deleteUploadedFiles"] = true;