MultiPowUpload 2.1 control documentation

MultiPowUpload movie parameters 


Attention! Inside Javascript code at flashvars values replace symbols " with the \" and \ with the \\ and symbols "&" with the "%26" at URL values!

Parameter

Type

Description

showLink

Boolean

Only for commercial version! Determines whether Flash will show MultiPowUpload lable with link. Default value is true

useExternalInterface

Boolean

Determines whether Flash will use External Interface i.e communication between Flash and the Java Script. Default value is true

fontFamily

String

The font name for text. The default value is "_sans".

fontSize

Integer

The font size for text. The default value is 12.

listUseRollOver

Boolean

Determines whether rolling over a row activates highlighting. The default value is true.

showIOError

Boolean

Determines whether occured IO error will be shown or Flash will try upload file again. The default value is false(Tryes to upload again). For details see Known bugs and limitations

removeUploadedFilesFromList

Boolean

Remove or not uploaded files from list when upload complete. Default value is true

cancelImmediately

Boolean

Cancel upload/download immediately or wait while file will be fully uploaded. Default value is true

numberRetry

Integer

The number of times Flash will try to upload file if IO error occures. Default value is 3

javaScriptEventsPrefix

String

Prefix for MultiPowUpload Java Script events names. Default value is MultiPowUpload

labelUploadVisible

Boolean

Determines whether label "Select files to Upload" visible or not. The default value is true.

browseButtonVisible

Boolean

Determines whether browseButton visible or not. The default value is true.

removeButtonVisible

Boolean

Determines whether removeButton visible or not. The default value is true.

clearButtonVisible

Boolean

Determines whether clearButton visible or not. The default value is true.

uploadButtonVisible

Boolean

Determines whether uploadButton visible or not. The default value is true.

progressBarVisible

Boolean

Determines whether own movie progress bar will be shown or not. Default value is true

prepareButtonVisible

Boolean

Determines whether prepareButtonVisible visible or not. The default value is true.

dateFormatString

String

Pattern to show files date. Default value is d.m.Y H:i

Characters types:
  Description Example returned values
a Lowercase Ante meridiem and Post meridiem am or pm
A Uppercase Ante meridiem and Post meridiem AM or PM
d Day of the month, 2 digits with leading zeros 01 to 31
D Textual representation of a day, three letters Mon through Sun*
F Full textual representation of a month January through December*
g 12-hour format of an hour without leading zeros 1 through 12
G 24-hour format of an hour without leading zeros 0 through 23
h 12-hour format of an hour with leading zeros 01 through 12
H 24-hour format of an hour with leading zeros 00 through 23
i Minutes with leading zeros 00 to 59
j Day of the month without leading zeros 1 to 31
l Full textual representation of the day of the week (lowercase 'L') Sunday through Saturday*
L Whether it's a leap year 1 if it is a leap year, 0 otherwise
m Numeric representation of a month, with leading zeros 01 through 12
M Short textual representation of a month, three letters Jan through Dec*
n Numeric representation of a month, without leading zeros 1 through 12
O Difference to Greenwich time (GMT) in hours Example: 5 (for EST )
s Seconds, with leading zeros 00 throguh 59
t Number of days in the given month 28 through 31
U Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)  
w Numeric representation of the day of the week 0 (for Sunday) through 6 (for Saturday)
Y Full numeric representation of a year, 4 digits Examples: 1999 or 2003
y Two digit representation of a year Examples: 99 or 03
uploadUrl

URL

The URL of the server script configured to handle upload through HTTP POST calls. The URL can be HTTP only.
If you are using symbols "&" at uploadUrl value replace them with the "%26" string!
Special characters at URL must be encoded (like "~" should be "%7E")!!! Otherwise willn't work at Mac OS

redirectUploadUrl

URL

URL of the page that automatically will be loaded after upload is finished.
Component will POST to the specified URL the uploaded files details in format MultiPowUploadFileName_0=firstfilename, MultiPowUploadFileSize_0=firstfilesize, etc . Code of the script can retrive files details like for standard POST variables:
ASP code Example:

externalVariablesUrl

URL

Url of the xml file that contain MultiPowUpload parameters.

redirectTarget

String

Target to redirect redirectUploadUrl. The same like "target" parameter in <a> html tag. Default value is _self

fileTypes

String

An array of file types used to filter the files displayed in the dialog box. Example:

All files|*.*;Images|*.jpg\\;*.jpeg\\;*.gif\\;*.png\\;*.bmp
Default value is All files|*.* (All files are displayed)

maxFileSize

Integer

Maximum file size each allowed for upload in bytes. Default value is -1 (Unlimited)

maxFileCount

Integer

Maximum number of files allowed for upload. Default value is -1 (Unlimited)

maxFileSizeTotal

Integer

Maximum total files size allowed for upload in bytes. Default value is -1 (Unlimited)

customPostFields

String

List of parameters that will be added to post request in upload mode. Example:

paramname1;paramvalue1|paramname2;paramvalue2 

formName

String

Id of form on html page wich values should be included in request.

uploadFileFieldName

String

Name of file form field in request. Default value is Filedata

sendTestRequest

Boolean

Determines whether MultiPowUpload should send test request or not. Default value is false

sendFieldsByGetMethod

Boolean

Determines whether MultiPowUpload should send form fields with GET method. Default value is false

sendFileId

Boolean

Determines whether MultiPowUpload should send file id. Default value is true

sendFileCreationDate

Boolean

Determines whether MultiPowUpload should send file creation date. Default value is true

sendFileModificationDate

Boolean

Determines whether MultiPowUpload should send file modification date. Default value is true

sendFileSize

Boolean

Determines whether MultiPowUpload should send file size. Default value is true

sendFilesCount

Boolean

Determines whether MultiPowUpload should send files count. Starts from 1. Default value is true

sendCurrentFileIndex

Boolean

Determines whether MultiPowUpload should send current file index. Starts from zero. Default value is true

sendBrowserCookie

Boolean

Determines whether MultiPowUpload should send browser cookies. MultiPowUpload use JavaScript to grab browser cookie. Default value is true

fileIdFieldName

String

Name of fileid form field in request. Default value is fileId

fileCreationDateFieldName

String

Name of creation date form field in request. Default value is fileCreationdate

fileModificationDateFieldName

String

Name of modification date form field in request. Default value is fileModificationDate

fileSizeFieldName

String

Name of file size form field in request. Default value is fileSize

filesCountFieldName

String

Name of file form field in request. Default value is filesCount

currentFileIndexFieldName

String

Name of current file index form field in request. Default value is currentFileIndex

browserCookieFieldName

String

Name of browser cookie form field in request. Default value is MultiPowUpload_browserCookie

sendThumbnails

Boolean

Determines whether MultiPowUpload should send current image thumbnails.
Note: due to Adobe API limitations MultiPowUpload can't provide progress information for thumbnails upload process.
Default value is false

sendOriginalImages

Boolean

Determines whether MultiPowUPLoad should send original images to server when sendThumbnails parameter set to true. Default value is true

getThumbnailFromExif

Boolean

Determines whether MultiPowUpload should use thumbnail from exif (if exist) as source image for thumbnail creation. Default value is true

thumbnailAutoRotate

Boolean

Determines wheter MultiPowUPLoad should automatically rotate thumbnails using information from EXIF (if available). Default value is false

thumbnailExactSize

Boolean

Deterimes wheter MultiPowUpload should generate thumbnails with size that match thumbnailsWith and thumbnailsHeigth values. If set to true thumbnail will always have size thumbnailsWith X thumbnailsHeigth. "Unused" space filled with thumbnailBackgroundColor color. If set to false thumbnails will have size related to original image aspect ratio. Default value is false

thumbnailWidth

Integer

Width of thumbnail that will be posted to server. Default value is 160

thumbnailHeight

Integer

Height of thumbnail that will be posted to server. Default value is 120

thumbnailFormat

String

Image format of thumbnail that will be posted to server. Possible values: "JPG", "PNG". Default value is JPG

thumbnailJPGQuality

Integer

Used if thumbnailFormat parameter set to "JPG". JPEG quality of thumbnail that will be posted to server. Possible range: 0-100. Default value is 85

thumbnailTransparentBackground

Boolean

Determines whether MultiPowUpload should generate thumnail with transparent background. Transparent background not supported by JPEG image format. Set thumbnailFormat parameter to "PNG" if you want generate thumbnails with transparent background. Default value is false

thumbnailBackgroundColor

Color

Background color of thumbnail that will be posted to server. Default value is #000000

thumbnailUploadUrl

URL

The URL of the server script configured to handle upload through HTTP POST calls. The URL can be HTTP only. If you are using symbols "&" at uploadUrl value replace them with the "%26" string! Special characters at URL must be encoded (like "~" should be "%7E")!!! Otherwise willn't work at Mac OS.

MultiPowUpload send all thumbnails in one POST request. Original image files posted to uploadUrl. If thumbnailUploadUrl is empty MultiPowUpload use uploadUrl value to post thumbnails.
thumbnailFormFieldName

String

Name of file form field in request. Default value is thumbnail_<COUNTER> Where is value from 0 to count of image files in file list.

thumbnailFileName

String

Name of thumbnail file in request. Default value is thumbnail_<FILENAME> Where is name of original image file. File extension replaced with "jpg" or "png" (depends on thumbnailFormat parameter).

rotateAngleFieldName

String

Name of appropriate form field in request. Form field with this name will contain rotation angle value. Default value is rotateAngle

rotateAngleBeforeCropFieldName

String

Name of appropriate form field in request. Form field with this name will contain rotation angle before crop operation value. Default value is rotateAngleBeforeCrop

cropRectXFieldName

String

Name of appropriate form field in request. Form field with this name will contain x coordinate in pixels (of original image) of crop rectangle. Default value is cropRectX

cropRectYFieldName

String

Name of appropriate form field in request. Form field with this name will contain y coordinate in pixels (of original image) of crop rectangle. Default value is cropRectY

cropRectWidthFieldName

String

Name of appropriate form field in request. Form field with this name will contain width in pixels (of original image) of crop rectangle. Default value is cropRectWidth

cropRectHeightFieldName

String

Name of appropriate form field in request. Form field with this name will contain height in pixels (of original image) of crop rectangle. Default value is cropRectHeight

downloadMode

Boolean

Determines whether Flash Movie has interface to download files. Default value is false

filesToDownload

String

List of files to show when Flash is in Download mode (downloadMode=true). Format:
URL1|FileName1|Size1;URL2|FileName2|Size2 (etc.)
Example:

landscape.jpg|landscape.jpg|48546;frog.jpg|frog.jpg|45119
Default value is Empty string

customList

Boolean

Determines whether Flash Movie use custom file list. Default value is true

customListShowProgressBar

Boolean

Show progress bar for each file. Default value is true

customListShowTextInput

Boolean

Show or not text input for each file. Default value is true

customListShowRemoveButton

Boolean

Show remove button for each file. Default value is true

customListRemoveButtonText

String

Label of remove button in custom list. Default value: "Remove"

customListTextInputName

String

Name of form field in request. Default value: "userText"

customListTextInputDefaultString

String

Default text in text input. Default value: "Put file description here"

customListTextInputBackgroundColor

Color

Background color of text input. Default value:

customListTextInputTextColor

Color

Font color of text input. Default value: #000000

showAboutMenuItem

Boolean

Show or not "about" menu item in context menu. Default value is true

backgroundColor

Color

The background color of the Flash movie. The default color is #F8F6E6

textColor

Color

The color of top lable text. The default color is #000000

buttonTextColor

Color

The color of buttons labels when button is active. The default color is #0B333C

buttonBackgroundColor

Color

The button background color when the button is up and active. The default color is #F8F6E6

buttonBottomBorderColor

Color

The button bottom border color when the button is active. The default color is #585F63

buttonTopBorderColor

Color

The button top border color when the button is active. The default color is #B7BABC

buttonDisabledTextColor

Color

The color of buttons labels when button is disabled. The default color is #848384

buttonDisabledBackgroundColor

Color

The button background color when the button is disabled. The default color is #F8F6E6

buttonDisabledBottomBorderColor

Color

The button bottom border color when the button is disabled. The default color is #585F63

buttonDisabledTopBorderColor

Color

The button top border color when the button is disabled. The default color is #B7BABC

buttonRollOverBottomBorderColor

Color

The button bottom border color when the pointer rolls over it. The default color is #0075BF

buttonRollOverTopBorderColor

Color

The button top border color when the pointer rolls over it. The default color is #009DFF

buttonDownBottomBackgroundColor

Color

The button bottom background color when button pressed. The default color is #99D7FE

buttonDownTopBackgroundColor

Color

The button top background color when button pressed. The default color is #D9F0FE

buttonDownBottomBorderColor

Color

The button bottom border color when button pressed. The default color is #0075BF

buttonDownTopBorderColor

Color

The button top border color when button pressed. The default color is #009DFF

listTextColor

Color

The text color of items in list. The default color is #000000

listTextSelectedColor

Color

The text color of of items in list in the selected row. The default color is #005F33

listTextRollOverColor

Color

The text color of of items in list when the pointer rolls over it. The default color is #2B333C

listBackgroundColor

Color

The background color of the list. The default color is #FFFFFF

listRollOverColor

Color

The background color of a row when the pointer rolls over it. The default color is #DAF1FF

listUpColor

Color

The background color of a row. The default color is #FFFFFF

listDownColor

Color

The background color of a pressed row. The default color is #E3FFD6

listSelectedUpColor

Color

The background color of a selected row. The default color is #9AD8FF

listSelectedDownColor

Color

The background color of a selected and pressed row. The default color is #9AD8FF

listSelectedRollOverColor

Color

The background color of a selected row when the pointer rolls over it. The default color is #DAF1FF

listUnuploadedColor

Color

The background color of item in list when it was not uploaded or downloaded. The default color is #FF0000

listUploadedColor

Color

The background color of item in list when it was uploaded or downloaded. The default color is #00FF00

progressBarLeftColor

Color

The left foreground color in denoting the percent complete. The default color is #99D7FE

progressBarRightColor

Color

The right foreground color in denoting the percent complete. The default color is #D9F0FE

progressBarLeftBorderColor

Color

The lefth border color. The default color is #0075BF

progressBarRightBorderColor

Color

The right border color. The default color is #009DFF

labelUploadText

String

Default value: "Select Files to upload"

uploadButtonText

String

Default value: "Upload"

browseButtonText

String

Default value: "Browse..."

removeButtonText

String

Default value: "Remove item"

clearListButtonText

String

Default value: "Clear list"

cancelButtonText

String

Default value: "Cancel"

prepareButtonText

String

Default value: "Prepare"

totalSizeText

String

Default value: "Total files size <SIZE>"

progressUploadCompleteText

String

Default value: "Upload complete"

progressUploadingText

String

Default value: "Uploading..."

progressUploadCanceledText

String

Default value: "Next files upload canceled. Wait..."

progressUploadStoppedText

String

Default value: "Upload stopped"

progressDownloadPausedText

String

Default value: "Download paused. Press download button to continue."

progressUploadThumbnailsText

String

Default value: "Uploading thumbnails, please wait..."

progressGenerateThumbnail

String

Default value: "Generating image thumbnails... please wait."

progressReadyForUpload

String

Default value: "Files ready for upload. Press upload button to start."

progressMainText

String

Default value: "<PERCENT>% Uploaded (<FILESNUM> files)<PART2DIV><BR>Transfer rate: <RATEVALUE>/sec<BR>Time left: <LEFTMIN> min <LEFTSEC> sec"

Also can be used following patterns:
<FAILCOUNT> - Count of unuploaded files.
<SUCCESSCOUNT> - Count of successfully uploaded files.
<FILESTOUPLOADCOUNT> - Total files count.

retryDialogYesLabel

String

Default value: "Yes"

retryDialogNoLabel

String

Default value: "No"

retryDialogCaption

String

Default value: "Retry upload?"

retryDialogMessage

String

Default value: "Some files was not uploaded. Do you want to try upload again?"

labelDownloadText

String

Default value: "Select Files to download"

downloadButtonText

String

Default value: "Download"

progressDownloadCompleteText

String

Default value: "Download complete"

progressDownloadingText

String

Default value: "Downloading..."

progressDownloadCanceledText

String

Default value: "Next files download canceled. Wait..."

progressDownloadStoppedText

String

Default value: "Download stopped"

fileSizeExceedMessage

String

Default value: "Only files less than <MAXFILESIZE> Kb are allowed. <COUNTINVALIDFILES> files were ignored!"

fileSizeTotalExceedMessage

String

Default value: "Total files size should be less than <MAXFILESIZETOTAL> Kb. <COUNTINVALIDFILES> files were ignored!"

filesCountExceedMessage

String

Default value: "Only <MAXFILECOUNT> files allowed to upload! <COUNTINVALIDFILES> files were ignored!"

zeroSizeMessage

String

Default value: "<COUNTINVALIDFILES> files with zero size were ignored!"

fileTypeWrongMessage

String

Default value: "Only files with following type: <FILETYPES> allowed to upload! <COUNTINVALIDFILES> files were ignored!"

uploadUrlEmptyMessage

String

Default value: "Upload script URL (uploadUrl parameter) is empty!"

httpErrorMessage

String

Default value: "<center>HTTP Error, '<ERRORCODE>' occurred. <DESCRIPTION> <br> Please see <font color='#0000FF'><a title='Error description' target='_blank' href='<W3WLINK>'><W3WLINK></a></font> error code definitions for more information. </center>"

httpErrorCodeDescription_400

String

Default value: "Bad Request. Server can't understand request! Please contact Element-IT support team in this case."

httpErrorCodeDescription_401

String

Default value: "Unauthorized. User authentication required!"

httpErrorCodeDescription_402

String

Default value: "Payment Required. Reserved code!"

httpErrorCodeDescription_403

String

Default value: "Forbidden. The server understood the request, but is refusing to fulfill it!<br>
For apache servers: This happens because you have enabled an Apache module named mod_security on server which blocks the headers sent by Flash.<br>
For IIS with ASP servers: This issue occurs if a Content-Length header is present and if the Content-Length header specifies an amount of data that is larger than the value of the AspMaxRequestEntityAllowed property in the IIS metabase.<br>
The default value for the AspMaxRequestEntityAllowed property is 204,800 bytes."

httpErrorCodeDescription_404

String

Default value: "Page not found. Can't find '<URL>' page on server!"

httpErrorCodeDescription_405

String

Default value: "Post method not allowed for this page <URL>! Please try to change server settings to allow post method for recieving script."

httpErrorCodeDescription_406

String

Default value: "Not Acceptable. This mean that server can't generate response entities which have content characteristics not acceptable according to the accept headers sent in the request.
Flash accept header is 'text/*'."

httpErrorCodeDescription_407

String

Default value: "Proxy Authentication Required."

httpErrorCodeDescription_408

String

Default value: "Request Timeout."

httpErrorCodeDescription_409

String

Default value: "Conflict."

httpErrorCodeDescription_410

String

Default value: "Gone. The requested resource is no longer available at the server and no forwarding address is known."

httpErrorCodeDescription_411

String

Default value: "Length Required."

httpErrorCodeDescription_412

String

Default value: "Precondition Failed."

httpErrorCodeDescription_413

String

Default value: "Request Entity Too Large.<br>
For IIS servers: 1. Try to increase UploadReadAheadSize metabase property.<br>
2. Try to increase MaxRequestEntityAllowed property value in IIS config.<br>
For apache servers: Try to increase LimitRequestBody parameter in httpd.conf."

httpErrorCodeDescription_414

String

Default value: "Request-URI Too Long."

httpErrorCodeDescription_415

String

Default value: "Unsupported Media Type."

httpErrorCodeDescription_416

String

Default value: "Requested Range Not Satisfiable."

httpErrorCodeDescription_417

String

Default value: "Expectation Failed."

httpErrorCodeDescription_500

String

Default value: "Internal Server Error. Usually it means that receiving script have errors."

httpErrorCodeDescription_501

String

Default value: "Not Implemented. Server does not support POST method."

httpErrorCodeDescription_502

String

Default value: "Bad Gateway."

httpErrorCodeDescription_503

String

Default value: "503 Service Unavailable. The server is currently unable to handle the request due to a temporary overloading or maintenance of the server."

httpErrorCodeDescription_504

String

Default value: "Gateway Timeout."

httpErrorCodeDescription_505

String

Default value: "HTTP Version Not Supported. Server does not support HTTP 1.1."

sortAscLabel

String

Default value: "Sort ASC"

sortDescLabel

String

Default value: "Sort DESC"

sortByNameLabel

String

Default value: "Sort by name"

sortBySizeLabel

String

Default value: "Sort by size"

sortByDateLabel

String

Default value: "Sort by date"

fileListPattern

String

Gives way to change file list representation. Possible patterns: <FILENAME>, <SIZE>, <DATE> Default value: <FILENAME> (<SIZE>)

labelUploadWidth

Integer

Default value: 400

labelUploadHeight

Integer

Default value: 22

labelUploadX

Integer

Default value: 10

labelUploadY

Integer

Default value: 7

browseButtonWidth

Integer

Default value: 94

browseButtonHeight

Integer

Default value: 22

browseButtonX

Integer

Default value: 4

browseButtonY

Integer

Default value: 28

removeButtonWidth

Integer

Default value: 100

removeButtonHeight

Integer

Default value: 22

removeButtonX

Integer

Default value: 117

removeButtonY

Integer

Default value: 28

clearListButtonWidth

Integer

Default value: 94

clearListButtonHeight

Integer

Default value: 22

clearListButtonX

Integer

Default value: 338

clearListButtonY

Integer

Default value: 28

filesListWidth

Integer

Default value: 440

filesListHeight

Integer

Default value: 230

filesListX

Integer

Default value: 4

filesListY

Integer

Default value: 61

uploadButtonWidth

Integer

Default value: 94

uploadButtonHeight

Integer

Default value: 22

uploadButtonX

Integer

Default value: 4

uploadButtonY

Integer

Default value: 305

labelInfoWidth

Integer

Default value: 330

labelInfoHeight

Integer

Default value: 60

labelInfoX

Integer

Default value: 110

labelInfoY

Integer

Default value: 300

progressBarWidth

Integer

Default value: 328

progressBarX

Integer

Default value: 110

progressBarY

Integer

Default value: 295