←Select platform

CancelAsync Method

Summary
Cancels a pending asynchronous operation.
Syntax
C#
VB
C++
Java
public void CancelAsync() 
Public Sub CancelAsync()  
public void cancelAsync(Object operation) 
public: 
void CancelAsync();  
Remarks

NOTE: This topic is part of RasterCodecs Async support using the .NET System.ComponentMode.AsyncOperation model. For .NET async/await support this type/member is not used. Instead, refer to RasterCodecs Async Operations.

The RasterCodecs object supports getting information, loading and saving image files asynchronously through the use of the GetInformationAsync, LoadAsync, LoadSvgAsync and SaveAsync methods. These methods will use an internal WebClient object to perform their operations and this object will be created automatically on the first call to these methods and can be accessed through the AsyncWebClient property.

If it is desired to create the WebClient object manually (for example, to subscribe to any of its event or set the credentials prior to invoking any read operations), you can call UseAsync to create the object, change its behavior and then call GetInformationAsync, LoadAsync, LoadSvgAsync or SaveAsync.

Note: UseAsync, AsyncWebClient, IsAsyncBusy, and CancelAsync are only applicable when the GetInformationAsync, LoadAsync, LoadSvgAsync or SaveAsync was with the versions that take a Uri parameter. The versions that take a String or a Stream do not use a WebClient object internally.

If you want to check the progress or cancel the operation, then use the LoadImage event as normal.

Example
C#
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
public void CancelAsyncExample() 
{ 
	string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
	Uri uri = new Uri(srcFileName); 
 
	RasterCodecs codecs = new RasterCodecs(); 
 
	// Now Load the file asynchronously 
	codecs.LoadAsyncCompleted += new EventHandler<CodecsLoadAsyncCompletedEventArgs>(cancelAsyncExample_LoadAsyncCompleted); 
	RasterImage image = codecs.LoadAsync(uri, null); 
 
	// Cancel it immediatly, in normal situation, the cancelation will happen 
	// before the LoadAsync method has a chance to load the file and 
	// the message "User canceled" will be displayed on the console 
	if (codecs.IsAsyncBusy) 
	{ 
		codecs.CancelAsync(); 
	} 
} 
 
private void cancelAsyncExample_LoadAsyncCompleted(object sender, CodecsLoadAsyncCompletedEventArgs e) 
{ 
	if (e.Cancelled) 
	{ 
		Console.WriteLine("User canceled"); 
	} 
	else if (e.Error != null) 
	{ 
		Console.WriteLine("Error: " + e.Error.Message); 
	} 
	else 
	{ 
		// Get the image 
		RasterImage image = e.Image; 
		Console.WriteLine("Image loaded asynchronously: Size = {0} by {1}", image.Width, image.Height); 
		image.Dispose(); 
	} 
 
	// Unsubscribe to the event and dispose the RasterCodecs object 
	RasterCodecs codecs = sender as RasterCodecs; 
	codecs.LoadAsyncCompleted -= new EventHandler<CodecsLoadAsyncCompletedEventArgs>(cancelAsyncExample_LoadAsyncCompleted); 
	codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images"; 
} 
Requirements

Target Platforms

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

Leadtools.Codecs Assembly