Documentation for the outdated version. Latest Aurigma Upload Suite docs

Background color of the specified upload thumbnail.

Syntax

Get/Set Value in Runtime

JavaScript

getImageUploader("ImageUploaderID").setUploadThumbnailBackgroundColor(Index, value);
value = getImageUploader("ImageUploaderID").getUploadThumbnailBackgroundColor(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 color value specified as a hex representation of the RGB triad in HTML-style syntax (#rrggbb) or as a color name ("white" and so on) which specifies the background color of the specified thumbnail.

Note

See the full list of supported color names in MSDN. Pay attention that user-defined colors are not supported.

Remarks

This color is used when the specified thumbnail should be created for an image with transparency.

If the two-pane layout is used, the default color will be the same as the FolderPaneBackgroundColor value. If the three-pane layout is used, the default color will be the same as the UploadPaneBackgroundColor value.

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.