In This Topic ▼

cancel Property

Summary

Indicates whether or not to cancel the image load of an ImageLoader.

Syntax

TypeScript

JavaScript

Object.defineProperty(ImageLoaderPreRunEventArgs.prototype, 'cancel', 
	get: function(), 
	set: function(value) 
)

cancel: boolean;

true to cancel the image request. The default is false.

Remarks

Set this property to true to cancel the image load during the ImageLoader.PreRun event. This will cause the ImageLoader.Fail event to be called.

See ImageLoader and ImageLoader.Run for more information.

Requirements

Help Version 21.0.2021.6.30