1. Image Uploader 6.5 Dual
  2. Reference
  3. API Reference
  4. ImageUploader Class
  5. ImageUploader Methods
This documentation is for the old version. Go to the latest Upload Suite docs

ImageUploader.UploadThumbnailAdd Method

Supported in: ActiveX , Java

Adds new element to the list of upload thumbnails.

Syntax

JavaScript 
getImageUploader("ImageUploaderID").UploadThumbnailAdd(FitMode, Width, Height);

Parameters

FitMode

A member of the enumeration that specifies a fit mode of new upload thumbnail:

String valueInteger valueDescription
Off0Do not send a thumbnail of this size to the server.
Fit1Send a thumbnail which is resized to fit the specified rectangle.
Width2 Send a thumbnail which is resized to have the width which is not larger than the specified one.
Height3 Send a thumbnail which is resized to have the height which is not larger than the specified one.
Icon4Send an icon of the file instead of the thumbnail.
ActualSize5 Send the image of the original size (rotating and recompressing it if necessary).

If unsupported string value is passed, it is interpreted as Off.

Note

When you receive this value through the JavaScript, integer value will be returned (even if you initialize appropriate property with a string value).

Width
A non-negative integer value that specifies a width of new upload thumbnail.
Height
A non-negative integer value that specifies a height of new upload thumbnail.

Return Value

An integer value that specifies an index of newly added item.

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.

To configure other settings than fit mode and thumbnail dimensions, use appropriate UploadThumbnailXXX property. E.g. to change the JPEG quality, use the UploadThumbnailJpegQuality property.

If you choose to send resized thumbnails, you can specify the quality of resizing with the UploadThumbnailResizeQuality property.

You can also remove the upload thumbnail list element with the UploadThumbnailRemove() method.

See Also

Manual

Reference