backImage Property (ImageViewerItem)

Summary

Optional background element associated with this item.

Syntax

JavaScript Syntax
Object.defineProperty(ImageViewerItem.prototype, 'backImage', 
	get: function(), 
	set: function(value) 
) 
TypeScript Syntax
backImage: HTMLElement; 

Property Value

The optional background element associated with this item. Default value is null.

Remarks

The background element is optional and does not affect the size or resolution of the item. The viewer will check this value during the rendering cycle, and if a background image is found, it will be rendered during RenderItem just before the main image of the item (if any).

Changing the value of this property will fire the ItemChanged event with ImageViewerItemChangedReason.BackImage.

BackImage property of ImageViewer will update this member if this is the active item when the viewer is used in single item mode.

In Elements Mode, the BackImage may be any element (e.g., svg) instead of just an img. Refer to Image Viewer User-Defined HTML Display for more information.

For more information, refer to Image Viewer Items.

Requirements

Target Platforms

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
Leadtools.Controls Assembly
Click or drag to resize