This documentation is for the old version. Go to the latest Upload Suite docs

ImageUploader.UploadThumbnailCompressOversizedOnly Property

Supported in: ActiveX , Java

Switch that specifies whether an original file should be uploaded as the specified thumbnail in case when original image dimensions and file size are not bigger than dimensions and file size of the thumbnail.

Syntax

Get/Set Value in Runtime

JavaScript
getImageUploader("ImageUploaderID").setUploadThumbnailCompressOversizedOnly(Index, value);
value = getImageUploader("ImageUploaderID").getUploadThumbnailCompressOversizedOnly(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 boolean value (true or false). If true and:

  • The original file is JPEG;
  • No watermark is applied;
  • The dimensions of the original file are not bigger than the dimensions of the specified thumbnail;
  • The size in bytes of the original file is not greater than the size of the specified thumbnail.

Then the original file will be sent instead of the specified upload thumbnail. In all other cases a thumbnail is created.

Remarks

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.

See Also

Manual

Reference