abort Method

Summary

Aborts the current ImageLoader, guaranteeing that callbacks for Done, Fail, or Always will not be run.

Syntax

JavaScript Syntax

ImageLoader.prototype.abort = function( 
   )

TypeScript Syntax

abort( 
): void;

Remarks

The use of Abort is separate from Cancel - the former ensures no callbacks will be run for the ImageLoader when it finishes, while the latter will ensure the Fail event handler will be called instead of loading the image.

Abort is called internally by Dispose, so calling both is unnecessary. Once Abort has been called, the ImageLoader is permanently unusable. Dispose will reset or clear all properties on ImageLoader, while Abort will maintain references or values for all properties. If the user does not wish to abort the image load, the best time to call Dispose is in the Always callback.

Requirements

Target Platforms

Reference

ImageLoader Class

ImageLoader Members

Leadtools Namespace

Help Version 19.0.2017.10.27

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Assemblies