Leadtools.Windows.Controls.Pro Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.03.25
Load(Stream,Int32,CodecsLoadByteOrder,Int32) Method
See Also  Example
Leadtools.Windows.Controls Namespace > RasterImageViewerElement Class > Load Method : Load(Stream,Int32,CodecsLoadByteOrder,Int32) Method




stream
A Stream containing the the image data to load.
bitsPerPixel

Resulting image pixel depth. Valid values are:

valuemeaning
0Keep the original file's pixel depth (do not convert the image).
1 to 8The specified bits per pixel in the resulting image.
1212 bits per pixel in the resulting image.
1616 bits per pixel in the resulting image.
2424 bits per pixel in the resulting image.
3232 bits per pixel in the resulting image.
4848 bits per pixel in the resulting image.
6464 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. The following values are valid:

ValueMeaning
CodecsLoadByteOrder.RgbRed, green, and blue color order in memory.
CodecsLoadByteOrder.BgrBlue, green, and red color order in memory.
CodecsLoadByteOrder.Gray12- or 16-bit grayscale image. 12- and 16-bit grayscale images are only supported in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RgbOrGrayLoad 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.BgrOrGrayLoad 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.RommROMM order. ROMM only supports 24- and 48-bit images.
CodecsLoadByteOrder.BgrOrGrayOrRommLoad 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.
Loads the specified image stream using specific options

Syntax

Visual Basic (Declaration) 
Overloads Public Sub Load( _
   ByVal stream As Stream, _
   ByVal bitsPerPixel As Integer, _
   ByVal order As CodecsLoadByteOrder, _
   ByVal page As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterImageViewerElement
Dim stream As Stream
Dim bitsPerPixel As Integer
Dim order As CodecsLoadByteOrder
Dim page As Integer
 
instance.Load(stream, bitsPerPixel, order, page)
C# 
public void Load( 
   Stream stream,
   int bitsPerPixel,
   CodecsLoadByteOrder order,
   int page
)
Managed Extensions for C++ 
public: void Load( 
   Stream* stream,
   int bitsPerPixel,
   CodecsLoadByteOrder order,
   int page
) 
C++/CLI 
public:
void Load( 
   Stream^ stream,
   int bitsPerPixel,
   CodecsLoadByteOrder order,
   int page
) 

Parameters

stream
A Stream containing the the image data to load.
bitsPerPixel

Resulting image pixel depth. Valid values are:

valuemeaning
0Keep the original file's pixel depth (do not convert the image).
1 to 8The specified bits per pixel in the resulting image.
1212 bits per pixel in the resulting image.
1616 bits per pixel in the resulting image.
2424 bits per pixel in the resulting image.
3232 bits per pixel in the resulting image.
4848 bits per pixel in the resulting image.
6464 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. The following values are valid:

ValueMeaning
CodecsLoadByteOrder.RgbRed, green, and blue color order in memory.
CodecsLoadByteOrder.BgrBlue, green, and red color order in memory.
CodecsLoadByteOrder.Gray12- or 16-bit grayscale image. 12- and 16-bit grayscale images are only supported in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RgbOrGrayLoad 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.BgrOrGrayLoad 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.RommROMM order. ROMM only supports 24- and 48-bit images.
CodecsLoadByteOrder.BgrOrGrayOrRommLoad 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.

Example

This example will show how to load an image using different bits per pixel and color order. Also, it will show how to load a single page from a multipage file. All loading operations load from a stream rather than from a file on disk.

Visual BasicCopy Code
Public Sub RasterImageViewerElement_Load1(ByVal viewer As RasterImageViewerElement)
   Dim multiPageFileName As String = "C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Eye.gif"

   Dim fs As FileStream = File.OpenRead(multiPageFileName)

   ' Load the first page
   Dim first As Integer = 1
   viewer.Load(fs, 0, CodecsLoadByteOrder.BgrOrGray, first)
   Console.WriteLine("Loading pages {0}", first)
   viewer.Image.Dispose()

   ' Load the second page
   first = 2
   viewer.Load(fs, 0, CodecsLoadByteOrder.BgrOrGray, first)
   Console.WriteLine("Loading pages {0}", first)
   viewer.Image.Dispose()
End Sub
C#Copy Code
public void RasterImageViewerElement_Load1(RasterImageViewerElement viewer) 

   string multiPageFileName = @"C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Eye.gif"; 
 
   FileStream fs = File.OpenRead(multiPageFileName); 
 
   // Load the first page 
   int first = 1; 
   viewer.Load(fs, 0, CodecsLoadByteOrder.BgrOrGray, first); 
   Console.WriteLine("Loading pages {0}", first); 
   viewer.Image.Dispose(); 
 
   // Load the second page 
   first = 2; 
   viewer.Load(fs, 0, CodecsLoadByteOrder.BgrOrGray, first); 
   Console.WriteLine("Loading pages {0}", first); 
   viewer.Image.Dispose(); 
}

Remarks

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.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Vista, and Windows Server 2003 family

See Also

Leadtools.Windows.Controls.Pro.dxp requires a WFP Module license and unlock key. For more information, refer to: Raster Pro/Document/Medical Features and Unlocking Special LEAD Features.