UseAsync Method

Summary

Creates the WebClient object used for asynchronous operations.

Syntax

C++/CLI

Python

public void UseAsync()

public: 
void UseAsync();

def UseAsync(self):

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 takes 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

This example will use UseAsync to create the WebClient object used by a RasterCodecs object for asynchronous operations. It will then change the cache policy of the web client object before loading an image asynchronously.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
public void UseAsyncExample() 
{ 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   Uri uri = new Uri(srcFileName); 
 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // The RasterCodecs.AsyncWebClient is null first 
   Debug.Assert(codecs.AsyncWebClient == null); 
 
   // Force the RasterCodecs object to create it 
   codecs.UseAsync(); 
 
   // Change the Cache policy 
   codecs.AsyncWebClient.CachePolicy = new System.Net.Cache.RequestCachePolicy(System.Net.Cache.RequestCacheLevel.CacheOnly); 
 
   // Now Load the file asynchronously 
   codecs.LoadAsyncCompleted += new EventHandler<CodecsLoadAsyncCompletedEventArgs>(useAsyncExample_LoadAsyncCompleted); 
   RasterImage image = codecs.LoadAsync(uri, null); 
} 
 
private void useAsyncExample_LoadAsyncCompleted(object sender, CodecsLoadAsyncCompletedEventArgs e) 
{ 
   if (e.Cancelled) 
   { 
      Debug.WriteLine("User canceled"); 
   } 
   else if (e.Error != null) 
   { 
      Debug.WriteLine("Error: " + e.Error.Message); 
   } 
   else 
   { 
      // Get the image 
      RasterImage image = e.Image; 
      Debug.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>(useAsyncExample_LoadAsyncCompleted); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Download our FREE evaluation

Help Version 22.0.2023.5.5

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies