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

ImageUploader.ShowDescriptions Property

Supported in: ActiveX , Java

Switch that specifies whether to display Edit Description elements under the thumbnails.

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

Get/Set Value in Runtime

JavaScript
getImageUploader("ImageUploaderID").setShowDescriptions(value);
value = getImageUploader("ImageUploaderID").getShowDescriptions();

Property Value

A boolean value (true or false). If true, the Edit Description elements are displayed under the thumbnails, otherwise they are invisible.

Default value is "true".

Remarks

Note

This property has a lower priority than the FolderPaneShowDescriptions and UploadPaneShowDescriptions properties. It means that if both these properties are set to false in the script used to embed Image Uploader, Edit Description elements will be invisible even through the ShowDescriptions is set to true.

If these fields are visible, users can write descriptions for files before the upload. Descriptions can be added only in the Thumbnails view. Other view modes do not support it.

If this property is enabled and some descriptions are added, they are uploaded along with the images. These descriptions are sent in Description_N POST fields (where N is the index of an image). So the upload processing script (specified with the Action property) must analyze these fields as well. If this property is set to false, these fields are not uploaded.

See Also

Manual

Reference