Compression mode of the specified thumbnail.

Syntax

Get/Set Value in Runtime

JavaScript

getImageUploader("ImageUploaderID").setUploadThumbnailCompressionMode(Index, value);
value = getImageUploader("ImageUploaderID").getUploadThumbnailCompressionMode(Index);

Parameters

Index

A positive integer that specifies an index of the upload thumbnail (one-based). It should not exceed UploadThumbnailCount. If extra upload thumbnails are required, use the UploadThumbnailAdd() method to add them.

Property Value

A string value that specifies the compression mode format string of the specified thumbnail. See the Remarks section for more details about syntax of this string.

Remarks

Thumbnail, in Image Uploader terms, is not just a resized copy of an original image; it can also be an icon associated with a source file, its ZIP archive, or contain this file itself. This property defines what data (resized image, ZIP archive, system icon, or source file) should be uploaded for what file types. Data types, so-called compression modes, are specified using predefined constants. Image Uploader supports the following compression modes:

Jpeg
If a file selected for upload is image, Image Uploader resizes this image to the specified dimensions and uploads it as JPEG file. Otherwise if file is non-image, Image Uploader uploads a system icon associated with the file. By default, this mode is applied to any file regardless of its extension. More information about image resizing before upload you can read in the Resizing and Rotating Images topic.
Zip
Image Uploader sends a ZIP archive of the original file.
Icon
Image Uploader sends a system icon associated with a file selected for the upload.
SourceFile
Image Uploader sends the original file.

File types are specified with file masks which can be constructed using standard wildcards, such as asterisk * (arbitrary substring) and question mark ? (arbitrary character). In a common case, this property accepts a string which has the following syntax:

mask11,mask12,...=mode1,mode2,...;mask21,mask22,...=mode1,mode2,...;...

This string consists of file masks=compression modes pairs separated by semicolons. Each pair defines a type of uploaded data which should be sent for listed file types. Thus, a single thumbnail (the UploadThumbnailX POST field) can contain data of different types depending on type of the selected file. Find examples of compression mode format strings in the Handling Files Compression topic.

Note

You can specify several compression modes for one list of file types. In that case if applying of the first compression mode has failed Image Uploader will try to use the next one. For example, if you set this property to the "*.*=Jpeg,SourceFile" value, Image Uploader will send either JPEG thumbnail or source file in the case when it is unable to create JPEG thumbnail for a selected file (when this file is corrupted or non-image).

Image Uploader can generate multiple thumbnails per one file sent to the server. To configure sizes of thumbnails and other parameters, you can manipulate a list of upload thumbnail settings. It can be done two ways:

  1. Use UploadThumbnailNXXX parameters, where N is a number in range from 1 to 3.
  2. Use the UploadThumbnailAdd() method in JavaScript to add extra thumbnail sizes, and UploadThumbnailXXX properties to change specific settings.

First method is simpler, however it allows to upload not more than 3 thumbnails per one file. The second one does not have any limitation on the number of thumbnails.

To get an upload thumbnail on the server use the UploadThumbnailX HTTP POST field, where X is an index of the upload thumbnail.

Note

The index of upload thumbnail list is one-based.