Image Uploader has a big number of parameters (about 300 for ActiveX and almost 200 for Java), which you can modify to get it working exactly in the way you need. This topic gives a brief overview for Image Uploader parameters.
How to Modify Parameters
After you add Image Uploader on the page, you should insert parameters using the addParam method of the ImageUploaderWriter JavaScript object that is defined in the iuembed.js . You should pass the name of the property and its value. See the Helper Script Reference (iuembed.js) for more details.
Inserting Your License Key
The first parameter that you should add to your script that embeds Image Uploader
into the page is a license key. There are two types of license keys: trial and full.
Trial license key allows evaluating Image Uploader on any domain (not only on
localhost
). See the How to Evaluate Image Uploader
for more details. Full license keys remove limitations of the evaluation version; find the detailed information about these keys
in the Removing Limitations of Evaluation Version topic.
The key (or keys) are specified as a value of the LicenseKey property. Here is how you can do that (note that if you have several keys, they should be
delimited with semi-colons):
![]() |
|
---|---|
iu.addParam("LicenseKey", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX;YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY"); |
As you see, the value of the LicenseKey property is set just like any other Image Uploader parameter.
Image Uploader Parameters
All Image Uploader parameters can be divided into several groups which are described below.
![]() |
---|
Though the lists below contain plenty of parameters, these lists are incomplete as it is impossible to mention here all available parameters. For the full list of properties that configure Image Uploader and its behavior, see the API Reference. |
![]() |
---|
Some parameters have effect on ActiveX or Java version only. The following marking is used.
Members that work for both versions are not marked. |
Appearance Parameters
A big number of parameters of Image Uploader have an effect on its look-and-feel. Figures demonstrating which property corresponds to which element of Image Uploader can be found in the Customizing Appearance.
Pane Appearance Parameters
A crucial part of Image Uploader are its panes that contain files and folder tree. Image Uploader supports several kind of view modes and layouts, which are described in the Image Uploader User Interface topic.
Appearance of Image Uploader panes can be easily configured with the properties from the table below.
Name | Description | |
---|---|---|
![]() ![]() |
FolderPaneBorderStyle | Border style of the folder pane. |
![]() ![]() |
FolderPaneHeight | Height of the folder pane. |
![]() ![]() |
PaneLayout | Layout of Image Uploader panes. |
![]() ![]() |
TreePaneBorderStyle | Border style of the tree pane. |
![]() ![]() |
TreePaneWidth | Width of the folder tree pane. |
![]() ![]() |
UploadPaneBorderStyle | Border style of the upload pane. |
![]() ![]() |
FolderView | View mode for the folder pane. |
![]() ![]() |
UploadView | View mode for the upload pane. |
Color Parameters
Image Uploader has many elements with customizable colors. Some of them use system-defined colors by default,
and to be able to change them, it is necessary to set UseSystemColors
to false.
To see an example how to work with color properties, take a look into the Changing Background Colors for Panes topic.
The table below contains all color properties of the ImageUploader control.
Name | Description | |
---|---|---|
![]() ![]() |
AdvancedDetailsFailedItemBackgroundColor | Background color of an item in AdvancedDetails view which indicates that this item failed to be uploaded. |
![]() ![]() |
AdvancedDetailsGridLineColor | Color of grid lines in AdvancedDetails view when the grid is enabled. |
![]() ![]() |
AdvancedDetailsIdleItemBackgroundColor | Background color of an item in AdvancedDetails view which indicates items which are pending for upload. |
![]() ![]() |
AdvancedDetailsInProcessItemBackgroundColor | Background color of an item in AdvancedDetails view which indicates items which are being uploaded. |
![]() ![]() |
BackgroundColor | Background color of the Image Uploader surface. |
![]() ![]() |
DisplayNameActiveSelectedTextColor | Color of the item display name when this item is selected and the focus is set on the pane which contains this item. |
![]() ![]() |
DisplayNameActiveUnselectedTextColor | Color of the item display name when this item is not selected and the focus is set on the pane which contains this item. |
![]() ![]() |
DisplayNameInactiveSelectedTextColor | Color of the item display name when this item is selected and the focus is out of the pane which contains this item. |
![]() ![]() |
DisplayNameInactiveUnselectedTextColor | Color of the item display name when this item is not selected and the focus is out of the pane which contains this item. |
![]() |
EditDescriptionTextColor | Color of the text label displayed instead of the description when it is empty. |
![]() ![]() |
FolderPaneBackgroundColor | Background color of the folder pane. |
![]() ![]() |
IncorrectFileActiveSelectedTextColor | Color of the text caption displayed for the item which cannot be uploaded (e.g because of file filters) when this item is selected and the focus is set on the pane which contains this item. |
![]() ![]() |
IncorrectFileActiveUnselectedTextColor | Color of the text caption displayed for the item which cannot be uploaded (e.g because of file filters) when this item is not selected and the focus is set on the pane which contains this item. |
![]() ![]() |
IncorrectFileInactiveSelectedTextColor | Color of the text caption displayed for the item which cannot be uploaded (e.g because of file filters) when this item is selected and the focus is out of the pane which contains this item. |
![]() ![]() |
IncorrectFileInactiveUnselectedTextColor | Color of the text caption displayed for the item which cannot be uploaded (e.g because of file filters) when this item is not selected and the focus is out of the pane which contains this item. |
![]() ![]() |
PaneBackgroundColor | Background color of all Image Uploader panes. |
![]() |
PreviewThumbnailActiveDropHighlightedColor | Color of the thumbnail box selection when this thumbnail belongs to a focused pane and the user drags some items over it. |
![]() ![]() |
PreviewThumbnailActiveSelectionColor | Color of the item selection frame when the parent pane is in focus. |
![]() ![]() |
PreviewThumbnailBorderColor | Color of the preview thumbnail box frame. |
![]() ![]() |
PreviewThumbnailBorderHoverColor | Color of the preview box frame when the cursor is hovered over the thumbnail. |
![]() |
PreviewThumbnailInactiveDropHighlightedColor | Color of the thumbnail box selection when this thumbnail belongs to a pane which is out of focus and the user drags some items over it. |
![]() ![]() |
PreviewThumbnailInactiveSelectionColor | Color of item selection frame when the parent pane is out of focus. |
![]() ![]() |
QualityMeterHeight | Height of the whole quality meter element. |
![]() ![]() |
QualityMeterAcceptableQualityColor | Color of the quality meter element which corresponds to the maximum acceptable print format. |
![]() ![]() |
QualityMeterBackgroundColor | Background color of the quality meter. |
![]() ![]() |
QualityMeterBorderColor | Color of the quality meter border. |
![]() ![]() |
QualityMeterHighQualityColor | Color of the quality meter element which corresponds to the recommended print format. |
![]() ![]() |
QualityMeterLowQualityColor | Color of the quality meter element corresponding to the print format which is not recommended for printing. |
![]() |
SplitterLineColor | Color of the splitter line (if enabled). |
![]() ![]() |
TreePaneBackgroundColor | Background color of the tree pane. |
![]() ![]() |
UploadPaneBackgroundColor | Background color of the upload pane. |
Button Customization Parameters
Image Uploader allows to replace standard buttons by custom images. You can set a specific image for each button and each state of this button. The Customizing Buttons topic describes how to do it.
The list of the properties that are responsible for this functionality is given in the table below.
Name | Description | |
---|---|---|
![]() ![]() |
ButtonAddAllToUploadListImageFormat | List of images that specify different states of the Add All button. |
![]() ![]() |
ButtonAddFilesImageFormat | List of images that specify different states of the Add Files button. |
![]() ![]() |
ButtonAddFoldersImageFormat | List of images that specify different states of the Add Folders button. |
![]() ![]() |
ButtonAddToUploadListImageFormat | List of images that specify different states of the Add button (which adds selected files from folder pane to upload pane). |
![]() ![]() |
ButtonAdvancedDetailsCancelImageFormat | List of images that specify different states of the Cancel button which is displayed in the AdvancedDetails view during upload. |
![]() |
ButtonDeleteFilesImageFormat | List of images that specify different states of the button which deletes selected images. |
![]() ![]() |
ButtonDeselectAllImageFormat | List of images that specify different states of the button which deselects all items in the folder. |
![]() |
ButtonPasteImageFormat | List of images that specify different states of the Paste button. |
![]() ![]() |
ButtonRemoveAllFromUploadListImageFormat | List of images that specify different states of the Remove All button which removes all files from the upload list. |
![]() ![]() |
ButtonRemoveFromUploadListImageFormat | List of images that specify different states of the Remove button which removes selected files from the upload list. |
![]() ![]() |
ButtonSelectAllImageFormat | List of images that specify different states of the Select All button. |
![]() ![]() |
ButtonSendImageFormat | List of images that specify different states of the Send button. |
![]() ![]() |
ButtonStopImageFormat | List of images that specify different states of the Stop button. |
![]() ![]() |
CacheGuiGraphics | Switch that enables/disables caching of image buttons (when XXXImageFormat properties are used). |
![]() ![]() |
GuiGraphicsVersion | Version indicator of images used as buttons and icons of Image Uploader user interface. |
![]() ![]() |
LargePreviewIconImageFormat | List of images that specify different states of an icon displayed on the item which shows a large preview of the item. |
![]() ![]() |
RemoveIconImageFormat | List of images that specify different states of an icon displayed on the item which removes it from the upload list. |
![]() ![]() |
RotateIconClockwiseImageFormat | List of images that specify different states of an icon displayed on the item which rotates it clockwise. |
![]() ![]() |
RotateIconCounterclockwiseImageFormat | List of images that specify different states of an icon displayed on the item which rotates it counter-clockwise. |
Text Parameters
Image Uploader allows to change every text element of its GUI. In particular, this means that you can easily translate the GUI to any language. The Localization topic contains a examples of translation to several languages.
The table below presents a list of all text-related properties.
Name | Description | |
---|---|---|
![]() ![]() |
AddFolderDialogButtonCancelText | Caption of the Cancel button on the dialog displayed when the folders are being added to the upload list. |
![]() ![]() |
AddFolderDialogButtonSkipAllText | Caption of the Skip All button on the dialog displayed when the folders are being added to the upload list. |
![]() ![]() |
AddFolderDialogButtonSkipText | Caption of the Skip button on the dialog displayed when folders are being added to the upload list. |
![]() ![]() |
AddFolderDialogTitleText | Title of the dialog displayed when folders are being uploaded to the upload list. |
![]() |
AuthenticationRequestBasicText | Text of the message on the authentication dialog when basic authentication is used. |
![]() |
AuthenticationRequestButtonCancelText | Text of the Cancel button on the authentication dialog. |
![]() |
AuthenticationRequestButtonOkText | Text of the OK button on the authentication dialog. |
![]() |
AuthenticationRequestDomainText | Text of the Domain label on the authentication dialog. |
![]() |
AuthenticationRequestLoginText | Text of the Login label on the authentication dialog. |
![]() |
AuthenticationRequestNtlmText | Text of the message on the authentication dialog when NTLM authentication is used. |
![]() |
AuthenticationRequestPasswordText | Text of the Password label on the authentication dialog. |
![]() ![]() |
ButtonAddAllToUploadListText | Text of the button which adds all files in the current folder to upload list. |
![]() ![]() |
ButtonAddFilesText | Text of the button which displays the Open File dialog to select the files for the upload. |
![]() ![]() |
ButtonAddFoldersText | Text of the button which opens the standard Open Folder dialog to add the entire folder content to the upload list. |
![]() ![]() |
ButtonAddToUploadListText | Text of the button which adds selected files to the upload list. |
![]() ![]() |
ButtonAdvancedDetailsCancelText | Text of the Cancel button which is displayed in the AdvancedDetails view during upload. |
![]() |
ButtonDeleteFilesText | Text of the Delete Files button. |
![]() ![]() |
ButtonDeselectAllText | Text of the button which deselects all the items in the folder. |
![]() |
ButtonPasteText | Text for the Paste button. |
![]() ![]() |
ButtonRemoveAllFromUploadListText | Text of the button which removes all files from the upload list. |
![]() ![]() |
ButtonRemoveFromUploadListText | Text of the button which removes selected files from the upload list. |
![]() ![]() |
ButtonSelectAllText | Text of the button which selects all the items in the folder. |
![]() ![]() |
ButtonSendText | Text of the button which starts the upload of selected files. |
![]() ![]() |
ButtonStopText | Text of the button which aborts the upload. |
![]() ![]() |
CmykImagesAreNotAllowedText | Text which appears instead of the description text field if the image is CMYK when CMYK images are not allowed for the upload. |
![]() ![]() |
DescriptionEditorButtonCancelText | Text for the Cancel button of the description editor. |
![]() ![]() |
DescriptionEditorButtonOkText | Text on the OK button of the description editor. |
![]() ![]() |
DescriptionTooltipText | Text of the tooltip which is displayed when mouse cursor is hovering over the description text field. |
![]() ![]() |
DimensionsAreTooLargeText | Text of the label shown when image dimensions are larger than specified with the and the properties. |
![]() ![]() |
DimensionsAreTooSmallText | Text of the label displayed when image dimensions are smaller than specified with the and properties. |
![]() ![]() |
DropFilesHereText | Text of the label on the upload pane displayed when no files are selected for the upload. |
![]() ![]() |
EditDescriptionText | Text of the label displayed instead of the description when it is empty. |
![]() ![]() |
EditDescriptionTooltipText | Text of the tooltip which is displayed when mouse cursor is hovering over the Edit Description label-hyperlink. |
![]() ![]() |
FileIsTooLargeText | Text which appears instead of the description text field if the file exceeds the value. |
![]() ![]() |
FileIsTooSmallText | Text which appears instead of the description text field if the file is smaller than value. |
![]() |
HoursText | Text for the hours unit in the progress dialog. |
![]() ![]() |
IncludeSubfoldersText | Text of the Include Subfolders checkbox in the Open Folder dialog. |
![]() ![]() |
KilobytesText | Text for the kilobytes unit in the progress dialog. |
![]() ![]() |
LargePreviewIconTooltipText | Text of the tooltip which is displayed when the mouse pointer is hovering over the icon on an item that opens the large preview window. |
![]() ![]() |
ListColumnFileNameText | Title of the file name column in the Details view. |
![]() ![]() |
ListColumnFileSizeText | Title of the file size column in the Details view. |
![]() ![]() |
ListColumnFileTypeText | Title of the file type column in the Details view. |
![]() ![]() |
ListColumnLastModifiedText | Title of the last modification date column in the Details view. |
![]() ![]() |
ListKilobytesText | Text for kilobytes unit in the file size column of the Details view. |
![]() ![]() |
LoadingFilesText | Text on the folder pane which is displayed while Image Uploader scans the folder content and builds the file list. |
![]() ![]() |
MegabytesText | Text for the megabytes unit in the progress dialog. |
![]() ![]() |
MenuAddAllToUploadListText | Caption of the Add All To Upload List context menu item. |
![]() ![]() |
MenuAddToUploadListText | Caption of the Add To Upload List context menu item. |
![]() |
MenuArrangeByModifiedText | Caption of the Modified context menu item inside Arrange Icons By group. |
![]() |
MenuArrangeByNameText | Caption of the Name context menu item inside Arrange Icons By group. |
![]() |
MenuArrangeByPathText | Caption of the Path context menu item inside Arrange Icons By group. |
![]() |
MenuArrangeBySizeText | Caption of the Size context menu item inside Arrange Icons By group. |
![]() |
MenuArrangeByText | Caption of the Arrange Icons By context menu. |
![]() |
MenuArrangeByTypeText | Caption of the Type context menu item inside Arrange Icons By group. |
![]() |
MenuArrangeByUnsortedText | Caption of the Unsorted context menu item inside Arrange Icons By group. |
![]() ![]() |
MenuDeselectAllText | Caption of the Deselect All context menu item. |
![]() ![]() |
MenuDetailsText | Caption of the Details context menu item. |
![]() ![]() |
MenuIconsText | Caption of the Icons context menu item. |
![]() ![]() |
MenuInvertSelectionText | Caption of the Invert Selection context menu item. |
![]() ![]() |
MenuListText | Caption of the List context menu item. |
![]() ![]() |
MenuRefreshText | Caption of the Refresh context menu item. |
![]() ![]() |
MenuRemoveAllFromUploadListText | Caption of the Remove All From Upload List context menu item. |
![]() ![]() |
MenuRemoveFromUploadListText | Caption of the Remove From Upload List context menu item. |
![]() ![]() |
MenuSelectAllText | Caption of the Select All context menu item. |
![]() ![]() |
MenuThumbnailsText | Caption of the Thumbnails context menu item. |
![]() ![]() |
MessageBoxTitleText | Title of the message box which appears when some error occurs or upload is finished. |
![]() |
MessageCannotConnectToInternetText | Text of the error message which states that Image Uploader failed to connect to Internet. |
![]() ![]() |
MessageCmykImagesAreNotAllowedText | Text of the error message which states that the selected image is CMYK when CMYK images are not allowed for the upload. |
![]() ![]() |
MessageDimensionsAreTooLargeText | Text of the error message which states that the width or height of the selected image is too large. |
![]() ![]() |
MessageDimensionsAreTooSmallText | Text of the error message which states that the width or height of selected image is too small. |
![]() ![]() |
MessageFileSizeIsTooSmallText | Text of the error message which states that the user tries to select too small file. |
![]() ![]() |
MessageMaxFileCountExceededText | Text of the error message which states that the user tries to select too many files. |
![]() ![]() |
MessageMaxFileSizeExceededText | Text of the error message which states that the user tries to select too large file. |
![]() ![]() |
MessageMaxTotalFileSizeExceededText | Text of the error message which states that the total size of selected files is too large. |
![]() |
MessageNoInternetSessionWasEstablishedText | Text of the error message which states that there is no Internet session available. |
![]() ![]() |
MessageNoResponseFromServerText | Text of the error message which states that an error was encountered when sending a request to the server and the server did not return any response. |
![]() ![]() |
MessageRedirectText | Text of the message which states that the server returns HTTP code 3xx (e.g. 302 or 304), i.e. when it returns a redirect response. |
![]() |
MessageRetryOpenFolderText | Text of the message which is displayed when Image Uploader tries to restore last visited folder and it is not available. |
![]() ![]() |
MessageServerNotFoundText | Text of the error message which states that the server with the name, specified in the parameter, cannot be not found. |
![]() ![]() |
MessageSwitchAnotherFolderWarningText | Text of the warning message which is displayed when the user changes the current folder and some items are selected for upload in this folder. |
![]() ![]() |
MessageUnexpectedErrorText | Text of the user-friendly error message for errors which are meaningful to website developer only. |
![]() ![]() |
MessageUploadCancelledText | Text of the error message which states that the user cancelled the upload. |
![]() ![]() |
MessageUploadCompleteText | Text of the message box which notifies that the upload is successfully finished. |
![]() ![]() |
MessageUploadFailedText | Text of the error message which states that the upload failed because the connection was broken. |
![]() |
MessageUserSpecifiedTimeoutHasExpiredText | Text of the error message which states that the client-side timeout has expired. To disable this message, set it to an empty string. |
![]() |
MinutesText | Text for the minutes unit in the progress dialog. |
![]() ![]() |
ProgressDialogCancelButtonText | Caption of the Cancel button on the progress dialog. |
![]() ![]() |
ProgressDialogCloseButtonText | Caption of the Close button on the progress dialog. |
![]() ![]() |
ProgressDialogCloseWhenUploadCompletesText | Caption of the Close When Upload Completes checkbox in the progress dialog. |
![]() |
ProgressDialogEstimatedTimeText | Caption of the label on the progress dialog which displays estimated time of upload. |
![]() ![]() |
ProgressDialogPreparingDataText | Caption of the Preparing Data label on the progress dialog. |
![]() ![]() |
ProgressDialogSentText | Caption of the label on the progress dialog which specifies how many files have already been sent. |
![]() ![]() |
ProgressDialogTitleText | Title of the progress dialog. |
![]() ![]() |
ProgressDialogWaitingForResponseFromServerText | Text string which appears in the progress dialog when the upload completes and Image Uploader is waiting for a response from the server. |
![]() ![]() |
ProgressDialogWaitingForRetryText | Text string which appears in the progress dialog when the upload was interrupted and Image Uploader is waiting before retrying to recover the upload. |
![]() ![]() |
RemoveIconTooltipText | Text of the tooltip which is displayed when the mouse pointer is hovering over the icon on an item that removes this item from the upload list. |
![]() ![]() |
RotateIconClockwiseTooltipText | Text of the tooltip which is displayed when the mouse pointer is hovering over the icon on an item that rotates this item clockwise. |
![]() ![]() |
RotateIconCounterclockwiseTooltipText | Text of the tooltip which is displayed when the mouse pointer is hovering over the icon on an item that rotates this item counter-clockwise. |
![]() |
SecondsText | Text for seconds unit in the progress dialog. |
![]() |
TimeFormat | Text template that specifies how time should be displayed. |
![]() |
UnixFileSystemRootText | Caption of the folder tree node which specifies the system directory at *NIX systems. |
![]() |
UnixHomeDirectoryText | Caption of the folder tree node which specifies the home directory at *NIX systems. |
Behavior Parameters
Another group of parameters influence the behavior of Image Uploader. In other words, you can specify what the user can do and what they cannot do.
Feature Activation Parameters
You can activate or deactivate certain features. For example, if you do not want to allow your users to edit descriptions of uploaded files, you can just hide the description editor element.
A table below contains properties that activates or deactivates Image Uploader features.
Name | Description | |
---|---|---|
![]() ![]() |
AllowAutoRotate | Switch that enables automatic EXIF-based photo rotation feature. |
![]() ![]() |
AllowCmykImages | Switch that specifies whether it is possible to select CMYK images for the upload. |
![]() ![]() |
AllowFolderUpload | Switch that specifies whether it is possible to upload not only separate files, but also entire folders. |
![]() ![]() |
AllowLargePreview | Switch that specifies whether it is possible to open the large previw window for the items. |
![]() ![]() |
AllowMultipleRemove | Switch that specifies whether clicking on remove icon of a list item will remove all selected items. |
![]() ![]() |
AllowMultipleRotate | Switch that specifies whether clicking on rotate icon of a list item will rotate all selected items. |
![]() ![]() |
AllowMultipleSelection | Switch that specify whether the user is allowed to select multiple files at one time. |
![]() ![]() |
AllowRotate | Switch that specifies whether to display rotate icons on preview thumbnails. |
![]() |
AllowTreePaneWidthChange | Switch that specify whether the user can resize the tree pane. |
![]() ![]() |
CheckFilesBySelectAllButton | Switch that defines behavior of the Select All and Deselect All buttons (whether this button should check/uncheck or select/deselect files when clicked). |
![]() ![]() |
DescriptionsReadOnly | Indicator which specifies whether the user is allowed to edit descriptions. |
![]() ![]() |
EnableFileViewer | Switch that indicates whether to to open the file in associated viewer software when it is double-clicked. |
![]() ![]() |
EnableInstantUpload | Switch that specifies whether to upload files instantly when they were added to the upload pane. |
![]() ![]() |
EnableRemoveIcon | Switch that specifies whether to display remove icons on preview thumbnails. |
![]() ![]() |
FolderPaneAllowRotate | Switch that specifies whether to display rotate icons on thumbnails in the folder pane. |
![]() ![]() |
FolderPaneShowDescriptions | Switch that specifies whether Edit Description elements should be displayed under each thumbnail in the folder list. |
![]() ![]() |
SendDefaultFields | Switch that specifies whether to send standard text POST fields during the upload process. |
![]() ![]() |
RememberLastVisitedFolder | Switch that indicates whether Image Uploader should remember the last visited folder. |
![]() ![]() |
ShowContextMenu | Switch that specifies if the context menu should be available by a right-click on a folder or upload pane. |
![]() ![]() |
ShowDebugWindow | Switch that specifies whether to display an error page returned from the server if some error occurs on the page specified with the property. |
![]() ![]() |
ShowDescriptions | Switch that specifies whether to display Edit Description elements under the thumbnails. |
![]() |
ShowFileNames | Switch that specifies whether to display filenames in the folder and upload pane. |
![]() ![]() |
ShowSubfolders | Switch that specifies whether to display subfolders in the folder pane along with files. |
![]() ![]() |
SilentMode | Switch that specifies whether to hide Image Uploader progress bar and all the messages during the upload. |
![]() ![]() |
UploadPaneAllowRotate | Switch that specifies whether to display rotate icons on thumbnails in the upload pane. |
![]() ![]() |
UploadPaneShowDescriptions | Switch that specifies whether Edit Description elements should be displayed under each thumbnail in the upload list. |
Restriction Parameters
You can configure limitations for files that the user uploads and data the user enters. Several topics discussing this can be found in the Configuring Restriction Rules for Files in the manual section.
The properties from the table below can be used to set restrictions.
Name | Description | |
---|---|---|
![]() ![]() |
DeniedFileMask | File mask for the files that are denied to be displayed and uploaded. |
![]() ![]() |
FileMask | File mask for the files which are allowed to be displayed and uploaded. |
![]() ![]() |
MaxDescriptionTextLength | Maximum allowed number of characters in descriptions entered by the user. |
![]() ![]() |
MaxFileCount | Maximum number of files allowed for upload per one session. |
![]() ![]() |
MinFileCount | Minimum number of files allowed for upload per one session. |
![]() ![]() |
MaxFileSize | Maximum file size which is allowed for upload to the server. |
![]() ![]() |
MaxImageHeight | Maximum image height allowed for upload. |
![]() ![]() |
MaxImageWidth | Maximum image width allowed for upload. |
![]() ![]() |
MaxTotalFileSize | Maximum total file size allowed for upload. |
![]() ![]() |
MinFileSize | Minimum file size allowed for upload. |
![]() ![]() |
MinImageHeight | Minimum image height allowed for upload. |
![]() ![]() |
MinImageWidth | Minimum image width allowed for upload. |
Upload Parameters
As the main purpose of Image Uploader is to upload files, there is a number of properties that enable you to manage the upload process. The usage of these properties is described more detailed in topics of the Uploading section.
General Upload Settings
For better understanding of the purpose of most important upload settings, it is highly recommended to examine the Uploading Files Sequentially And Concurrently topic.
The information that describes how to configure Image Uploader to recover the upload process if it fails can be found in the Configuring Automatic Upload Recovery topic.
Name | Description | |
---|---|---|
![]() ![]() |
Action | URL of the page to which files selected for upload in Image Uploader are sent to. |
![]() ![]() |
AutoRecoverMaxTriesCount | Number of tries that should be performed to submit files. |
![]() ![]() |
AutoRecoverTimeOut | Interval in which Image Uploader should try to resume the upload if it was interrupted. |
![]() ![]() |
Charset | Charset used to encode the text data submitted by Image Uploader. |
![]() ![]() |
FilesPerOnePackageCount | Number of files which should be sent with a single request. |
![]() |
MaxConnectionCount | Number of simultaneous connections files are uploaded with. |
![]() ![]() |
TimeOut | Timeout of the HTTP connection. |
![]() ![]() |
UploadSourceFile | Switch that specifies whether original file should be uploaded or it is necessary to upload only resized copies. |
Additional Data Upload Settings
Image Uploader allows to sent not only files, but also additional data provided by the user or added through the JavaScript. See the Uploading Additional Data with Files topic for more details about this.
Also, you can have Image Uploader to extract meta information like EXIF and IPTC from images and upload it as separate fields. The Working with EXIF and IPTC Metadata topic describes how to do it.
And at last, Image Uploader can calculate hash values for uploaded files and send them to the server. It enables you to verify integrity of the uploaded data. See the Robust Upload Using Hash for information how to do it.
These properties are used to upload additional data to the server.
Name | Description | |
---|---|---|
![]() ![]() |
AdditionalFormName | Name of the HTML form with additional information which should be sent to the server along with files. |
![]() ![]() |
ExtractExif | List of EXIF fields which should be extracted and uploaded along with other data. |
![]() ![]() |
ExtractIptc | List of IPTC fields which should be extracted and uploaded along with other data. |
![]() ![]() |
HashAlgorithm | Algorithm to generate a hash value for each file to upload to the server. |
Upload Thumbnails Settings
Image Uploader allows to upload not only original files, but also resized copies of images. This way you can noticeable reduce the upload traffic amount. This is described more detailed in the Resizing and Rotating Images topic.
You can configure Image Uploader to upload up to three thumbnails of different sizes per image using parameters. If you need to upload more thumbnails per image, you can add extra upload thumbnails through the JavaScript.
These parameters configure upload thumbnails.
Name | Description | |
---|---|---|
![]() ![]() |
UploadThumbnail1BackgroundColor | Background color of the first thumbnail. |
![]() ![]() |
UploadThumbnail1CompressOversizedOnly | Switch that specifies if the original file should be sent when the dimensions of the original file and its file size are not greater than the dimensions and file size of the first thumbnail. |
![]() ![]() |
UploadThumbnail1CompressionMode | Compression mode of the first thumbnail. |
![]() ![]() |
UploadThumbnail1CopyExif | Switch that specifies whether the first thumbnail should contain EXIF metadata copied from the original file. |
![]() ![]() |
UploadThumbnail1CopyIptc | Switch that specifies whether the first thumbnail should contain IPTC metadata copied from the original file. |
![]() ![]() |
UploadThumbnail1FitMode | Fit mode of the first thumbnail. |
![]() ![]() |
UploadThumbnail1Height | Height restriction of the first thumbnail. |
![]() ![]() |
UploadThumbnail1JpegQuality | JPEG quality for the first thumbnail. |
![]() ![]() |
UploadThumbnail1ResizeQuality | Resize algorithm quality for the first thumbnail. |
![]() ![]() |
UploadThumbnail1Watermark | Watermark for the first thumbnail. |
![]() ![]() |
UploadThumbnail1Width | Width restriction of the first thumbnail. |
![]() ![]() |
UploadThumbnail2BackgroundColor | Background color of the second thumbnail. |
![]() ![]() |
UploadThumbnail2CompressOversizedOnly | Switch that specifies if the original file should be sent when the dimensions of the original file and its file size are not greater than the dimensions and file size of the second thumbnail. |
![]() ![]() |
UploadThumbnail2CompressionMode | Compression mode of the second thumbnail. |
![]() ![]() |
UploadThumbnail2CopyExif | Switch that specifies whether the second thumbnail should contain EXIF metadata copied from the original file. |
![]() ![]() |
UploadThumbnail2CopyIptc | Switch that specifies whether the first thumbnail should contain IPTC metadata copied from the original file. |
![]() ![]() |
UploadThumbnail2FitMode | Fit mode of the second thumbnail. |
![]() ![]() |
UploadThumbnail2Height | Height restriction of the second thumbnail. |
![]() ![]() |
UploadThumbnail2JpegQuality | JPEG quality for the second thumbnail. |
![]() ![]() |
UploadThumbnail2ResizeQuality | Resize algorithm quality for the second thumbnail. |
![]() ![]() |
UploadThumbnail2Watermark | Watermark for the second thumbnail. |
![]() ![]() |
UploadThumbnail2Width | Width restriction of the second thumbnail. |
![]() ![]() |
UploadThumbnail3BackgroundColor | Background color of the third thumbnail. |
![]() ![]() |
UploadThumbnail3CompressOversizedOnly | Switch that specifies if the original file should be sent when the dimensions of the original file and its file size are not greater than the dimensions and file size of the third thumbnail. |
![]() ![]() |
UploadThumbnail3CompressionMode | Compression mode of the third thumbnail. |
![]() ![]() |
UploadThumbnail3CopyExif | Switch that specifies whether the third thumbnail should contain EXIF metadata copied from the original file. |
![]() ![]() |
UploadThumbnail3CopyIptc | Switch that specifies whether the first thumbnail should contain IPTC metadata copied from the original file. |
![]() ![]() |
UploadThumbnail3FitMode | Fit mode of the third thumbnail. |
![]() ![]() |
UploadThumbnail3Height | Height restriction of the third thumbnail. |
![]() ![]() |
UploadThumbnail3JpegQuality | JPEG quality for the third thumbnail. |
![]() ![]() |
UploadThumbnail3ResizeQuality | Resize algorithm quality for the third thumbnail. |
![]() ![]() |
UploadThumbnail3Watermark | Watermark for the third thumbnail. |
![]() ![]() |
UploadThumbnail3Width | Width restriction of the third thumbnail. |
What Next?
After you configured Image Uploader parameters in the way you need, you can start writing the server-side code (i.e. the page specified by the Action property) as described in the Writing Server-Side Upload Code topic. Also, it makes sense to take a look into demo applications, which are distributed along with the Image Uploader SDK.