Leadtools.Codecs Namespace > RasterCodecs Class > LoadAsync Method : LoadAsync(String,Object) Method |
public RasterImage LoadAsync( string fileName, object userState )
'Declaration Public Overloads Function LoadAsync( _ ByVal fileName As String, _ ByVal userState As Object _ ) As RasterImage
'Usage Dim instance As RasterCodecs Dim fileName As String Dim userState As Object Dim value As RasterImage value = instance.LoadAsync(fileName, userState)
public RasterImage LoadAsync( string fileName, object userState )
public: RasterImage^ LoadAsync( String^ fileName, Object^ userState )
The file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.
This method will load all the pages in a multipage file. The resulting image will have the same bits/pixel and color order value of the image as it was stored in the file.
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 Image 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 Leadtools.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 Leadtools.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(String,LeadRect,Int32,CodecsLoadByteOrder,Int32,Int32,Object) 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. To load a single page, use LoadAsync(string fileName, int pageNumber, object userState).
Imports Leadtools Imports Leadtools.Codecs Imports Leadtools.ImageProcessing Imports Leadtools.ImageProcessing.Color Imports Leadtools.Drawing Public Sub LoadAsyncFile1Example() Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp") Dim codecs As New RasterCodecs() ' Now load the image asynchronously AddHandler codecs.LoadAsyncCompleted, AddressOf LoadAsyncFile1Example_LoadAsyncCompleted Dim rasterImageObject As Object = codecs.LoadAsync(srcFileName, Nothing) ' 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. End Sub Private Sub LoadAsyncFile1Example_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 ' Everything is OK, get the image Dim image As RasterImage = e.Image Console.WriteLine("Image at {0} loaded OK, size: {1} by {2}", e.FileName, 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 LoadAsyncFile1Example_LoadAsyncCompleted codecs.Dispose() End Sub Public NotInheritable Class LEAD_VARS Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" End Class
using Leadtools; using Leadtools.Codecs; using Leadtools.ImageProcessing; using Leadtools.ImageProcessing.Color; public void LoadAsyncFile1Example() { string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); RasterCodecs codecs = new RasterCodecs(); // Now load the image asynchronously codecs.LoadAsyncCompleted += new EventHandler<CodecsLoadAsyncCompletedEventArgs>(LoadAsyncFile1Example_LoadAsyncCompleted); object rasterImageObject = codecs.LoadAsync(srcFileName, 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 LoadAsyncFile1Example_LoadAsyncCompleted(object sender, CodecsLoadAsyncCompletedEventArgs e) { if (e.Cancelled) { Console.WriteLine("User canceled"); } else if (e.Error != null) { Console.WriteLine("Error: " + e.Error.Message); } else { // Everything is OK, get the image RasterImage image = e.Image; Console.WriteLine("Image at {0} loaded OK, size: {1} by {2}", e.FileName, 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>(LoadAsyncFile1Example_LoadAsyncCompleted); codecs.Dispose(); } static class LEAD_VARS { public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; }