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

ImageUploader.UploadPaneBackgroundImageFormat Property

Supported in: ActiveX , Java

Background image of the upload pane.

Syntax

Initialize

JavaScript

<script type="text/javascript" src="iuembed.js">  </script>
<script type="text/javascript">
var iu = new ImageUploaderWriter("ImageUploaderID", 610, 500);
//...other params...
iu.addParam("UploadPaneBackgroundImageFormat", "");
//...other params...
iu.writeHtml();
</script>

Get/Set Value in Runtime

JavaScript

getImageUploader("ImageUploaderID").setUploadPaneBackgroundImageFormat(value);
value = getImageUploader("ImageUploaderID").getUploadPaneBackgroundImageFormat();

Property Value

A string value that specifies settings of the upload pane background image. See the Remarks section for more details about syntax of this string.

Default value is "".

Remarks

The string which specifies settings of the upload pane background image has the following syntax:

variable1=value1;variable2=value2;...

The following variables are supported:

Variable	Description
Url	URL to the image that will be displayed on the upload pane. Mandatory.
Width	Width of the image that will be displayed on the upload pane. Mandatory. The image will be resized to the specified dimensions without keeping aspect ratio.
Height	Height of the image that will be displayed on the upload pane. Mandatory. The image will be resized to the specified dimensions without keeping aspect ratio.
Position	Image position. Optional. It can take one of the following values: TopLeft - image will be displayed in the top left corner of the upload pane. TopCenter - image will be displayed in the center of the top of the upload pane. TopRight - image will be displayed in the right top corner of the upload pane. CenterLeft - image will be displayed in the center of the left edge of the upload pane. Center - image will be displayed in the center of the upload pane. CenterRight - image will be displayed in the center of the right edge of the upload pane. BottomLeft - image will be displayed in the bottom left corner of the upload pane. BottomCenter - image will be displayed in the center of the bottom of the upload pane. BottomRight - image will be displayed in the bottom right corner of the upload pane. Default value is `Center`.

Note

The image format string is case insensitive.

You can use images of the all formats which are recognized by Image Uploader as images. If you load animated GIF files, only the first frame will be displayed.

You should obligatory specify width and height of the image. Otherwise the background image will not be displayed.

Image URL can be both absolute (e.g. Url=http://domain.com/images/button1.gif) and relative to the current page (e.g. Url=../images/button1.gif).

This property can be used with OnePane and ThreePanes layout. For more infomation read Layouts article.