Overloads Public Function Load( _
   ByVal fileName As String, _
   ByVal tile As LeadRect, _
   ByVal bitsPerPixel As Integer, _
   ByVal order As CodecsLoadByteOrder, _
   ByVal firstPage As Integer, _
   ByVal lastPage As Integer _
) As RasterImage

Visual Basic (Usage)	Copy Code
Dim instance As RasterCodecs Dim fileName As String Dim tile As LeadRect Dim bitsPerPixel As Integer Dim order As CodecsLoadByteOrder Dim firstPage As Integer Dim lastPage As Integer Dim value As RasterImage   value = instance.Load(fileName, tile, bitsPerPixel, order, firstPage, lastPage)

public RasterImage Load( 
   string fileName,
   LeadRect tile,
   int bitsPerPixel,
   CodecsLoadByteOrder order,
   int firstPage,
   int lastPage
)

public:
RasterImage^ Load( 
   String^ fileName,
   LeadRect tile,
   int bitsPerPixel,
   CodecsLoadByteOrder order,
   int firstPage,
   int lastPage
) 

Parameters

fileName

A System.String containing the name of the image file to load.

tile

A Leadtools.LeadRect describing the tile/area of the image 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-, 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. 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.

Return Value

This example will load the middle portion of the second page of a multipage file as 1 bits/pixel

Visual Basic

Copy Code

Public Sub LoadTileFile2Example() Dim codecs As RasterCodecs = New RasterCodecs() Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Eye.gif") Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_LoadTileFile2.bmp") ' Get the image dimension Dim pageNumber As Integer = 2 Dim info As CodecsImageInfo = codecs.GetInformation(srcFileName, True, pageNumber) ' Load the middle portion of the page Dim width As Integer = info.Width \ 3 Dim height As Integer = info.Height \ 3 Dim rc As LeadRect = New LeadRect((info.Width - width) \ 2, (info.Height - height) \ 2, width, height) Dim image As RasterImage = codecs.Load(srcFileName, rc, 1, CodecsLoadByteOrder.Rgb, 2, 2) Debug.Assert(image.PageCount = 1) Debug.Assert(image.Width = rc.Width) Debug.Assert(image.Height = rc.Height) ' Save this image back to disk codecs.Save(image, destFileName, RasterImageFormat.Bmp, 1) image.Dispose() ' Clean up 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 LoadTileFile2Example() { RasterCodecs codecs = new RasterCodecs(); string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Eye.gif"); string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_LoadTileFile2.bmp"); // Get the image dimension int pageNumber = 2; CodecsImageInfo info = codecs.GetInformation(srcFileName, true, pageNumber); // Load the middle portion of the page int width = info.Width / 3; int height = info.Height / 3; LeadRect rc = new LeadRect( (info.Width - width) / 2, (info.Height - height) / 2, width, height); RasterImage image = codecs.Load(srcFileName, rc, 1, CodecsLoadByteOrder.Rgb, 2, 2); Debug.Assert(image.PageCount == 1); Debug.Assert(image.Width == rc.Width); Debug.Assert(image.Height == rc.Height); // Save this image back to disk codecs.Save(image, destFileName, RasterImageFormat.Bmp, 1); image.Dispose(); // Clean up codecs.Dispose(); } static class LEAD_VARS { public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; }

SilverlightCSharp	Copy Code

SilverlightVB	Copy Code

This method loads a section of an image file (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 options 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.

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

Reference