image Property

Summary

HTML Image Element associated with this item.

Syntax

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

Property Value

The HTML Image Element associated with this item. Default value is null.

Remarks

The item can have a value in only one of Image, Element or Canvas. Setting one value will automatically delete the values of the others. Element accepts any element, but may still be null after the set operation. An HTML Image Element set to Element will actually be set to Image, and an HTML5 Canvas Element set to Element will actually be set to Canvas.

Changing the value of this property will fire the ItemChanged event with ImageViewerItemChangedReason.Image. The value of Resolution will not be automatically updated with the DPI of the new image. The user must set this value manually.

If the value of AutoCreateCanvas is true, then setting this value will create a canvas and set it in Canvas and the property value will be discarded.

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

For more information, refer to Image Viewer Items.

Example

JavaScript Example
var img = new Image(200, 200); 
 
var item = new lt.Controls.ImageViewerItem(); 
item.size = lt.LeadSizeD.create(img.width, img.height); 
item.text = "Item # 1"; 
item.image = img; 
 
this._imageViewer.beginUpdate(); 
this._imageViewer.items.add(item); 
this._imageViewer.endUpdate(); 

Requirements

Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly