LoadAsync(ILeadStream,LeadRect,Int32,CodecsLoadByteOrder,Int32,Int32) Method

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public IAsyncOperation<RasterImage> LoadAsync( 
   ILeadStream stream,
   LeadRect tile,
   int bitsPerPixel,
   CodecsLoadByteOrder order,
   int firstPage,
   int lastPage
)

'Declaration
 
Public Overloads Function LoadAsync( _
   ByVal stream As ILeadStream, _
   ByVal tile As LeadRect, _
   ByVal bitsPerPixel As Integer, _
   ByVal order As CodecsLoadByteOrder, _
   ByVal firstPage As Integer, _
   ByVal lastPage As Integer _
) As IAsyncOperation(Of RasterImage)

'Usage
 
Dim instance As RasterCodecs
Dim stream As ILeadStream
Dim tile As LeadRect
Dim bitsPerPixel As Integer
Dim order As CodecsLoadByteOrder
Dim firstPage As Integer
Dim lastPage As Integer
Dim value As IAsyncOperation(Of RasterImage)
 
value = instance.LoadAsync(stream, tile, bitsPerPixel, order, firstPage, lastPage)

public IAsyncOperation<RasterImage> LoadAsync( 
   ILeadStream stream,
   LeadRect tile,
   int bitsPerPixel,
   CodecsLoadByteOrder order,
   int firstPage,
   int lastPage
)

 function Leadtools.Codecs.RasterCodecs.LoadAsync(ILeadStream,LeadRect,Int32,CodecsLoadByteOrder,Int32,Int32)( 
   stream ,
   tile ,
   bitsPerPixel ,
   order ,
   firstPage ,
   lastPage 
)

public:
IAsyncOperation<RasterImage^>^ LoadAsync( 
   ILeadStream^ stream,
   LeadRect tile,
   int bitsPerPixel,
   CodecsLoadByteOrder order,
   int firstPage,
   int lastPage
)

Parameters

stream: An Leadtools.ILeadStream containing the image data to load.
tile: A Leadtools.LeadRect describing the tile/area of the image to load.
bitsPerPixel: Resulting image pixel depth.
order: Color order for 16-, 24-, 32-, 48-, 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.
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.

Return Value

When this method completes, it returns the image as a Leadtools.RasterImage.

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

Valid values are for the bitsPerPixel parameter 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.

Valid values are for the order parameter are:

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.

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 IAsyncOperation.Completed event to get notification when the LoadAsync(String,LeadRect,Int32,CodecsLoadByteOrder,Int32,Int32,Object) operation has completed and whether any errors occurred.

When this method completes, it returns the image as a Leadtools.RasterImage.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

[TestMethod]
public async Task LoadTileFile2Example()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName = @"Assets\eye.gif";
   string destFileName = @"Image1_LoadTileFile2.bmp";

   // Get the image dimension
   int pageNumber = 2;
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   CodecsImageInfo info = await codecs.GetInformationAsync(LeadStreamFactory.Create(loadFile), true, pageNumber);

   // Load the middle portion of the page
   int width = info.Width / 3;
   int height = info.Height / 3;
   LeadRect rc = LeadRectHelper.Create(
      (info.Width - width) / 2,
      (info.Height - height) / 2,
      width,
      height);

   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), rc, 1, CodecsLoadByteOrder.Rgb, 2, 2);
   Assert.IsTrue(image.PageCount == 1);
   Assert.IsTrue(image.Width == rc.Width);
   Assert.IsTrue(image.Height == rc.Height);

   // Save this image back to disk
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 1);
   image.Dispose();

   // Clean up
   codecs.Dispose();
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterCodecs Class
RasterCodecs Members
Overload List
Loading and Saving Images
Loading and Saving Large Tiff Files
Speeding Up 1-Bit Documents
Fast File Info