itemError Event

Summary

Occurs when an error happens when the viewer tries to update the item image data.

Syntax
TypeScript
JavaScript
Object.defineProperty(ImageViewer.prototype,'itemError', 
	get: function(), 
	set: function(value) 
) 
itemError: LeadEvent; 
Remarks

An error might occur if the image viewer is updating the image data of any of the items asynchronously or outside direct user programmatic interaction (such as during the drop part of a drag/drop operation). These operations do not occur from the user code (drop) or occur at a later time after they have been initiated (loading images asynchronously), therefore, the user must attach a handler to the ItemError event to be able to handle these errors.

When value of ImageViewerItem.Url is set to a new value, the image viewer will create a new HTML image element and use it to load the image data asynchronously using load and error events. This can be trigger by any of the following:

If an error occurs, it fires the ItemError event will fire with the following values set in ImageViewerItemErrorEventArgs:

Member Value

Item

The item that triggered the error

Reason

ImageViewerItemChangedReason.Url

Data

Set to null

Error

The error object

RemoveEmptyItem

Set to true to automatically remove this item if it did not have previous data.

When an image or file system item is dragged and dropped over the viewer and AllowDrop was set true, the viewer will try to automatically update or add a new item and load the new image data into it. An error might occur at this point and if so, the ItemError event will fire with the following values set in ImageViewerItemErrorEventArgs:

Member Value

Item

The item that triggered the error

Reason

ImageViewerItemChangedReason.Drop

Data

Set to the instance of ImageViewerItemDragDropEventArgs being used.

Error

The error object

RemoveEmptyItem

Set to true to automatically remove this item if it did not have previous data.

Example

For an example, refer to ItemChanged.

Event Data
ParameterTypeDescription
sendervarThe source of the event.
eImageViewerItemErrorEventArgsThe event data.
Requirements

Target Platforms

Help Version 22.0.2021.9.24
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.