- 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 the file). 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 palettized images have no order. Valid values are as follows:
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.
- page
- 1-based index of the page to load.
Visual Basic (Declaration) | |
---|---|
Overloads Public Sub Load( _ ByVal fileName As String, _ ByVal bitsPerPixel As Integer, _ ByVal order As CodecsLoadByteOrder, _ ByVal page As Integer _ ) |
Visual Basic (Usage) | Copy Code |
---|---|
|
C# | |
---|---|
public void Load( string fileName, int bitsPerPixel, CodecsLoadByteOrder order, int page ) |
C++/CLI | |
---|---|
public: void Load( String^ fileName, int bitsPerPixel, CodecsLoadByteOrder order, int page ) |
Parameters
- 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 the file). 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 palettized images have no order. Valid values are as follows:
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. - page
- 1-based index of the page to load.
This example will show how to load an image using different bits per pixel and color order from that saved on disk. Also, it will show how to load a single page from a multipage file.
Visual Basic | Copy Code |
---|---|
Public Sub RasterImageViewerElement_Load2(ByVal viewer As RasterImageViewerElement) |
C# | Copy Code |
---|---|
public void RasterImageViewerElement_Load2(RasterImageViewerElement viewer) |
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.
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: Microsoft .NET Framework 3.0, Windows XP, Windows Vista, and Windows Server 2003 family