LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
CancelAsync Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class : CancelAsync Method



Cancels a pending asynchronous operation.

Syntax

Visual Basic (Declaration) 
Public Sub CancelAsync() 
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
 
instance.CancelAsync()
C# 
public void CancelAsync()
C++/CLI 
public:
void CancelAsync(); 

Example

Visual BasicCopy Code
Public Sub CancelAsyncExample()
      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
      Dim uri As New Uri(srcFileName)

      Dim codecs As New RasterCodecs()

      ' Now Load the file asynchronously
      AddHandler codecs.LoadAsyncCompleted, AddressOf cancelAsyncExample_LoadAsyncCompleted
      Dim image As RasterImage = codecs.LoadAsync(uri, Nothing)

      ' 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 Then
         codecs.CancelAsync()
      End If
   End Sub

   Private Sub cancelAsyncExample_LoadAsyncCompleted(ByVal sender As Object, ByVal e As CodecsLoadAsyncCompletedEventArgs)
      If e.Cancelled Then
         Console.WriteLine("User canceled")
      ElseIf Not IsNothing(e.Error) Then
         Console.WriteLine("Error: " + e.Error.Message)
      Else
         ' Get the image
         Dim image As RasterImage = e.Image
         Console.WriteLine("Image loaded asynchronously: Size = {0} by {1}", image.Width, image.Height)
         image.Dispose()
      End If

      ' Unsubscribe to the event and dispose the RasterCodecs object
      Dim codecs As RasterCodecs = DirectCast(sender, RasterCodecs)
      RemoveHandler codecs.LoadAsyncCompleted, AddressOf cancelAsyncExample_LoadAsyncCompleted
      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
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:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
SilverlightVBCopy Code

Remarks

The RasterCodecs object supports getting information and loading image files asnchronously through the use of the RasterCodecs.GetInformationAsync and RasterCodecs.LoadAsync methods.

You can call one asyncronous operation per RasterCodecs object at a time. To check if the RasterCodecs object is busy with a previous asynchronous operation, use IsAsyncBusy property. This is the equivalant of the WebClient.IsBusy property of AsyncWebClient.

You can also use the CancelAsync method to cancel any current asynchronous operation in this RasterCodecs object. This is the equivalant of calling WebClient.CancelAsync on AsyncWebClient.

Note:UseAsync, AsyncWebClient, IsAsyncBusy, and CancelAsync are only applicable when the RasterCodecs.GetInformationAsync or RasterCodecs.LoadAsync was with the versions that take a System.Uri parameter. The versions thet take a System.String or a System.IO.Stream does not use a System.Net.WebClient object internally. If you want to check the progress or cancel the operation then use the LoadImage event as normal.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also