←Select platform

LoadAsync(Stream,LeadRect,object) Method

Loads the specified rectangle from the specified image stream using default options asynchronously.
public RasterImage LoadAsync( 
   Stream stream, 
   LeadRect tile, 
   object userState 
public Object loadAsync(ILeadStream stream, LeadRect tile, Object userState) 
RasterImage^ LoadAsync(  
   Stream^ stream, 
   LeadRect tile, 
   Object^ userState 
def LoadAsync(self,stream,tile,userState): 


A Stream containing the image data to load.

A LeadRect describing the tile/area of the image to load.

A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Return Value

The RasterImage object that this method loads. See remarks for the usage of this object.


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.

This method loads a section of an image stream (any format). The section begins is defined by  tile rectangle.

LEADTOOLS will attempt to load corrupted files so you can see at least a portion of the image. For these images, the load methods succeed, but LoadStatus will return an error code.

Use the CodecsLoadOptions class to set up other load option parameters before calling this method.

Support for 12 and 16-bit grayscale images is only available in the Document/Medical Imaging editions.

For supported formats, refer to Summary of All Supported File Formats.

LEADTOOLS loads all PDF files as Raster PDF uncompressed RasterImageFormat.RasPdf, regardless of the compression and color space used when saving the file.

The RasterCodecs class supports loading image files asynchronously using the LoadAsync methods. When calling any of these methods, the caller thread will not be blocked and the method will return instantly with an instance of RasterImage that is in a loading status (RasterImage.IsLoading set to true). You should not use the other properties of this object while the object is in loading status.

When the RasterCodecs object finishes loading the image, the various properties of the RasterImage will be populated with the image information and data and the RasterImage.IsLoading property will be set to false.

Do not poll the RasterImage.IsLoading property to determine whether the image has finished loading. Instead, subscribe to the LoadAsyncCompleted event to get notification when the LoadAsync operation has completed and whether any errors occurred.

The LoadAsyncCompleted event data will also contain the same object returned from LoadAsync so you do not have to keep the original object in your application.

The CodecsLoadOptions.AllPages property controls whether RasterCodecs will try to load all pages or just the first page if the image data contains multiple pages.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
public void LoadAsyncStream3Example() 
   RasterCodecs codecs = new RasterCodecs(); 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   // Load a random tile from the image asynchronously 
   LeadRect tileRect = new LeadRect(100, 50, 200, 150); 
   codecs.LoadAsyncCompleted += new EventHandler<CodecsLoadAsyncCompletedEventArgs>(LoadAsyncStream3Example_LoadAsyncCompleted); 
   Stream stream = File.OpenRead(srcFileName); 
   object rasterImageObject = codecs.LoadAsync(stream, tileRect, null); 
   // Notice that the returned rasterImageObject is a RasterImage with IsLoading set to true at this point 
   // The IsLoading will be false (and hence, the object will be usable) when the LoadAsyncCompleteted 
   // fires. 
private void LoadAsyncStream3Example_LoadAsyncCompleted(object sender, CodecsLoadAsyncCompletedEventArgs e) 
   if (e.Cancelled) 
      Debug.WriteLine("User canceled"); 
   else if (e.Error != null) 
      Debug.WriteLine("Error: " + e.Error.Message); 
      // Everything is OK, get the image 
      RasterImage image = e.Image; 
      Debug.WriteLine("Image loaded OK, size: {0} by {1}, order: {2}, bits/pixel: {3}", image.Width, image.Height, image.Order, image.BitsPerPixel); 
   // We should close the stream here 
   // Unsubscribe to the event and dispose the RasterCodecs object 
   RasterCodecs codecs = sender as RasterCodecs; 
   codecs.LoadAsyncCompleted -= new EventHandler<CodecsLoadAsyncCompletedEventArgs>(LoadAsyncStream3Example_LoadAsyncCompleted); 
static class LEAD_VARS 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
import java.io.*; 
import java.net.*; 
import java.nio.file.Paths; 
import java.util.*; 
import java.time.Instant; 
import java.time.Duration; 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.codecs.RasterCodecs.FeedCallbackThunk; 
import leadtools.drawing.internal.*; 
import leadtools.imageprocessing.*; 
import leadtools.imageprocessing.color.ChangeIntensityCommand; 
import leadtools.svg.*; 
public void loadAsyncStream3Example() throws IOException { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "Image1.cmp"); 
   // Load a random tile from the image asynchronously 
   LeadRect tileRect = new LeadRect(100, 50, 200, 150); 
   ILeadStream srcFileStream = LeadStreamFactory.create(srcFileName); 
   codecs.loadAsync(srcFileStream, tileRect, null); 
   assertTrue("Check that file exists", (new File(srcFileName)).exists()); 
   System.out.println("The file exists"); 
CodecsLoadAsyncCompletedListener loadAsyncStream3ExampleLoadAsyncCompleted = new CodecsLoadAsyncCompletedListener() { 
   public void onLoadAsyncCompleted(CodecsLoadAsyncCompletedEvent e) { 
      if (e.getCancelled()) { 
         System.out.println("User canceled"); 
      } else if (e.getError() != null) { 
         System.out.println("Error: " + e.getError().getMessage()); 
      } else { 
         // Everything is OK, get the image 
         RasterImage image = e.getImage(); 
         System.out.printf("Image loaded OK, size: %s by %s, order: %s, bits/pixel: %s%n", image.getWidth(), 
               image.getHeight(), image.getOrder(), image.getBitsPerPixel()); 
      // We should close the stream here 
      // Unsubscribe to the event and dispose the RasterCodecs object 
      RasterCodecs codecs = (RasterCodecs) e.getSource(); 

Target Platforms

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

Leadtools.Codecs Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.