LEADTOOLS JavaScript (Leadtools.Controls)
Products | Support | Email a link to this topic. | Send comments on this topic. | Back to Introduction | Help Version 19.0.4.3
ItemError Event
Show in webframe
| Leadtools.Controls Namespace > ImageViewer Object : ItemError Event |
add_itemError(function(sender, e)) itemError.add(function(sender, e)) remove_itemError(function(sender, e)) itemError.remove(function(sender, e))
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:
ImageViewerItems.AddFromUrl is called
ImageViewerItems.InsertFromUrl is called
ImageViewerItems.UpdateUrl is called
ImageViewerItem.Url is set to a new value
ImageViewer.ImageUrl is set to a new value
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 | |
| Data |
Set to the HTML |
| 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 | |
| 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. |
For an example, refer to ItemChanged.
| Parameter | Type | Description |
|---|---|---|
| sender | 'var' | The source of the event. |
| e | ImageViewerItemErrorEventArgs | The event data. |