Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.12.17
Load Method
See Also  Example
Leadtools.Codecs Namespace > RasterCodecs Class : Load Method




Loads the specified image file using default options.

Overload List

OverloadDescription
Load(String) Loads the specified image file using default options.  
Load(Stream) Loads the specified image stream using default options.  
Load(String,Int32,CodecsLoadByteOrder,Int32,Int32) Loads the specified image file using specific options.  
Load(Stream,Int32,CodecsLoadByteOrder,Int32,Int32) Loads the specified image stream using specific options  
Load(Stream,Int64,Int64) Loads an image file, letting you specify the location of the image data within the stream.  
Load(Stream,Int64,Int64,Int32,CodecsLoadByteOrder,Int32,Int32) Loads an image file, letting you specify the location of the image data within the stream and the options to use when loading.  
Load(String,Rectangle) Loads the specified rectangle from the specified image file using default options.  
Load(Stream,Rectangle) Loads the specified rectangle from the specified image stream using default options.  
Load(String,Rectangle,Int32,CodecsLoadByteOrder,Int32,Int32) Loads the specified rectangle from the specified image file using the specified options.  
Load(Stream,Rectangle,Int32,CodecsLoadByteOrder,Int32,Int32) Loads the specified rectangle from the specified image stream using the specified options.  
Load(String,Int32,Int32,Int32,RasterSizeFlags,CodecsLoadByteOrder) Loads an image file to the desired width, height, and bits per pixel, resizing the image as it loads.  
Load(String,Int32,Int32,Int32,RasterSizeFlags,CodecsLoadByteOrder,Int32,Int32) Loads an image file to the desired width, height, and bits per pixel, resizing as it loads.  
Load(Uri) Loads the specified image file using default options.  
Load(Uri,Int32,CodecsLoadByteOrder,Int32,Int32) Loads the specified image file using default options.  

Example

Visual BasicCopy Code
RasterCodecs.Load(string)
      Public Sub LoadFile1Example()
         RasterCodecs.Startup()
         Dim codecs As RasterCodecs = New RasterCodecs()

         Dim singlePageFileName As String = "C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Image1.cmp"
         Dim multiPageFileName As String = "C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Eye.gif"

         ' Get the file information (we are interested in the number of pages)
         Dim info As CodecsImageInfo = codecs.GetInformation(singlePageFileName, True)
         Console.WriteLine("Number of pages according to info: {0}", info.TotalPages)

         ' Load the image and verify that we loaded all the pages
         Dim image As RasterImage = codecs.Load(singlePageFileName)
         Console.WriteLine("Number of pages loaded: {0}", image.PageCount)
         Debug.Assert(image.PageCount = info.TotalPages)
         image.Dispose()

         ' Repeat for a multipage file

         info = codecs.GetInformation(multiPageFileName, True)
         Console.WriteLine("Number of pages according to info: {0}", info.TotalPages)

         image = codecs.Load(multiPageFileName)
         Console.WriteLine("Number of pages loaded: {0}", image.PageCount)
         Debug.Assert(image.PageCount = info.TotalPages)
         image.Dispose()

         ' Clean up
         codecs.Dispose()
         RasterCodecs.Shutdown()
      End Sub
C#Copy Code
RasterCodecs.Load(string) 
      public void LoadFile1Example() 
      { 
         RasterCodecs.Startup(); 
         RasterCodecs codecs = new RasterCodecs(); 
 
         string singlePageFileName = @"C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Image1.cmp"; 
         string multiPageFileName = @"C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Eye.gif"; 
 
         // Get the file information (we are interested in the number of pages) 
         CodecsImageInfo info = codecs.GetInformation(singlePageFileName, true); 
         Console.WriteLine("Number of pages according to info: {0}", info.TotalPages); 
 
         // Load the image and verify that we loaded all the pages 
         RasterImage image = codecs.Load(singlePageFileName); 
         Console.WriteLine("Number of pages loaded: {0}", image.PageCount); 
         Debug.Assert(image.PageCount == info.TotalPages); 
         image.Dispose(); 
 
         // Repeat for a multipage file 
 
         info = codecs.GetInformation(multiPageFileName, true); 
         Console.WriteLine("Number of pages according to info: {0}", info.TotalPages); 
 
         image = codecs.Load(multiPageFileName); 
         Console.WriteLine("Number of pages loaded: {0}", image.PageCount); 
         Debug.Assert(image.PageCount == info.TotalPages); 
         image.Dispose(); 
 
         // Clean up 
         codecs.Dispose(); 
         RasterCodecs.Shutdown(); 
      }

Remarks

The file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.

This method will load all the pages in a multipage file. The resulting image will have the same bits/pixel and color order value of the image as it was stored in the file.

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also