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

ImageUploader.ButtonStopImageFormat Property

Supported in: ActiveX , Java

List of images that are displayed in different states of the Stop button.

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("ButtonStopImageFormat", "");
//...other params...
iu.writeHtml();
</script>

Get/Set Value in Runtime

JavaScript
getImageUploader("ImageUploaderID").setButtonStopImageFormat(value);
value = getImageUploader("ImageUploaderID").getButtonStopImageFormat();

Property Value

A string value that specifies custom images for the Stop button. See the Remarks section for more details about syntax of this string. If an empty string is specified, standard button is drawn.

Default value is "".

Remarks

This property should be used if you want to replace standard Image Uploader buttons by your images. Each image corresponds to some state of this button: normal, pressed, disabled, etc. The string which specifies images for a button has the following syntax:

variable1=value1;variable2=value2;...

Here is a list of supported variables:

VariableDescription
Width Width of a button. If the button image has different size, it is resized (without keeping aspect ratio). Mandatory.
Height Height of a button. If the button image has different size, it is resized (without keeping aspect ratio). Mandatory.
BackgroundColor Button background color. Rectangle of specified width/height filled with this color is displayed while images for buttons are downloaded. If omitted, the BackgroundColor property is used.
UrlNormal URL to the image which represents the button when it is not pressed, mouse pointer is not hover over it, and the button is not in focus. Mandatory.
UrlNormalFocused The same as UrlNormal, but used when the button is in focus. If omitted, last drawn image will be used.
UrlHover URL to the image which represents a button when a mouse button is hovered over it. If omitted, last drawn image will be used.
UrlHoverFocused The same as UrlHover, but used when the button is in focus. If omitted, last drawn image will be used.
UrlPressed URL to the image which represents a button when it is pressed. If omitted, last drawn image will be used.
UrlDisabled URL to the image which represents a button when it is disabled. If omitted, last drawn image will be used.
Note

The 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 the image will be resized to. Otherwise standard button will be displayed. All other variables are optional, although it is recommended to specify all of them.

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

For example, if Image Uploader is inserted to the http://domain.com/ImageUploader/default.aspx page, the relative URLs specified via this property will correspond to the following locations.

Specified URLExpected Location
"/images/button1.gif"http://domain.com/images/button1.gif
"./images/button1.gif"http://domain.com/ImageUploader/images/button1.gif
"images/button1.gif"http://domain.com/ImageUploader/images/button1.gif
"button1.gif"http://domain.com/ImageUploader/button1.gif

While button images are being downloaded, Image Uploader uses background color specified with appropriate variable to mark an area where buttons will be drawn. To avoid re-downloading of button images each time the user visits a page with Image Uploader, use the CacheGuiGraphics property. If it is set to true, Image Uploader uses file cache of the browser to keep cached images. Otherwise (if this value is false) all buttons will be re-downloaded every time the user opens a page with Image Uploader.

See Also

Manual

Reference