Loads the specified image file using specific options asynchronously.
public RasterImage LoadAsync(
string fileName,
int bitsPerPixel,
CodecsLoadByteOrder order,
int firstPage,
int lastPage,
object userState
)
Public Overloads Function LoadAsync( _
ByVal fileName As String, _
ByVal bitsPerPixel As Integer, _
ByVal order As CodecsLoadByteOrder, _
ByVal firstPage As Integer, _
ByVal lastPage As Integer, _
ByVal userState As Object _
) As RasterImage
- (void)loadFileAsync:(NSString *)file
bitsPerPixel:(NSInteger)bitsPerPixel
order:(LTCodecsLoadByteOrder)order
firstPage:(NSInteger)firstPage
lastPage:(NSInteger)lastPage
completion:(void (^)(LTRasterImage * __nullable image, NSError * __nullable error))completion
public:
RasterImage^ LoadAsync(
String^ fileName,
int bitsPerPixel,
CodecsLoadByteOrder order,
int firstPage,
int lastPage,
Object^ userState
)
fileName
A String containing the name of the image file to load.
bitsPerPixel
Resulting image pixel depth. Valid values are:
Value | Meaning |
---|---|
0 | Keep the original file's pixel depth (Do not convert). |
1 to 8 | The specified bits per pixel in the resulting image. |
12 | 12 bits per pixel in the resulting image. |
16 | 16 bits per pixel in the resulting image. |
24 | 24 bits per pixel in the resulting image. |
32 | 32 bits per pixel in the resulting image. |
48 | 48 bits per pixel in the resulting image. |
64 | 64 bits per pixel in the resulting image. |
order
Color order for 16-bit, 24-bit, 32-bit, 48-bit, and 64-bit images. If the resulting image is less than 16 bits per pixel, this will have no effect since palletized images have no order. The following are valid values.
Value | Meaning |
---|---|
CodecsLoadByteOrder.Rgb | Red, green, and blue color order in memory |
CodecsLoadByteOrder.Bgr | Blue, green, and red color order in memory |
CodecsLoadByteOrder.Gray | 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are only supported in the Document/Medical Imaging editions. |
CodecsLoadByteOrder.RgbOrGray | Load the image as red, green, blue OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions |
CodecsLoadByteOrder.BgrOrGray | Load the image as blue, green, red OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions |
CodecsLoadByteOrder.Romm | ROMM order. ROMM only supports 24 and 48-bit images |
CodecsLoadByteOrder.BgrOrGrayOrRomm | Load the image as red, green, blue OR as a 12 or 16-bit grayscale image OR as ROMM. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions only. ROMM only supports 24 and 48-bit color images. |
firstPage
1-based index of the first page to load.
lastPage
The 1-based index of the last page to load. Must be greater than or equal to firstPage. You can pass -1 to load from firstPage to the last page in the file.
userState
A user-defined object that is passed to the method invoked when the asynchronous operation completes.
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
,
use Task<CodecsImageInfo> LoadAsync(ILeadStream stream, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage).
The file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.
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.
using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing;
using Leadtools.ImageProcessing.Color;
using Leadtools.Svg;
using LeadtoolsExamples.Common;
public void LoadAsyncFile2Example()
{
string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif");
RasterCodecs codecs = new RasterCodecs();
// Now load the first page of the image as 24 bits/pixel with order BGR asynchronously
codecs.LoadAsyncCompleted += new EventHandler<CodecsLoadAsyncCompletedEventArgs>(LoadAsyncFile2Example_LoadAsyncCompleted);
object rasterImageObject = codecs.LoadAsync(srcFileName, 24, CodecsLoadByteOrder.BgrOrGray, 1, 1, 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 LoadAsyncFile2Example_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}, order: {3}, bits/pixel: {4}", e.FileName, image.Width, image.Height, image.Order, image.BitsPerPixel);
image.Dispose();
}
// Unsubscribe to the event and dispose the RasterCodecs object
RasterCodecs codecs = sender as RasterCodecs;
codecs.LoadAsyncCompleted -= new EventHandler<CodecsLoadAsyncCompletedEventArgs>(LoadAsyncFile2Example_LoadAsyncCompleted);
codecs.Dispose();
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing
Imports Leadtools.ImageProcessing.Color
Imports Leadtools.Drawing
Imports Leadtools.Svg
Public Sub LoadAsyncFile2Example()
Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif")
Dim codecs As New RasterCodecs()
' Now load the first page of the image as 24 bits/pixel with order BGR asynchronously
AddHandler codecs.LoadAsyncCompleted, AddressOf LoadAsyncFile2Example_LoadAsyncCompleted
Dim rasterImageObject As Object = codecs.LoadAsync(srcFileName, 24, CodecsLoadByteOrder.BgrOrGray, 1, 1, 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 LoadAsyncFile2Example_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}, order: {3}, bits/pixel: {4}", e.FileName, image.Width, image.Height, image.Order, image.BitsPerPixel)
image.Dispose()
End If
' Unsubscribe to the event and dispose the RasterCodecs object
Dim codecs As RasterCodecs = DirectCast(sender, RasterCodecs)
RemoveHandler codecs.LoadAsyncCompleted, AddressOf LoadAsyncFile2Example_LoadAsyncCompleted
codecs.Dispose()
End Sub
Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document