←Select platform

Load(Stream,LeadRect) Method

Loads the specified rectangle from the specified image stream using default options.
public RasterImage Load( 
   Stream stream, 
   LeadRect tile 
public RasterImage load(ILeadStream stream, LeadRect tile) 
RasterImage^ Load(  
   Stream^ stream, 
   LeadRect tile 
def Load(self,stream,tile): 


A Stream containing the image data to load.

A LeadRect describing the tile/area of the image to load.

Return Value

The RasterImage object that this method loads.


This method loads a section of an image stream (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 option parameters before calling this method.

Support for 12 and 16-bit grayscale, and 48 and 64-bit color images is only available in the Document/Medical Imaging editions.

For supported formats, refer to Summary of All Supported 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 CodecsLoadOptions.AllPages property controls whether RasterCodecs will try to load all pages or just the first page if the image data contains multiple pages.


This example will create a rectangle area from a stream containing image data.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
public void LoadTileStream1Example() 
   RasterCodecs codecs = new RasterCodecs(); 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_LoadTileStream1.bmp"); 
   FileStream fs = File.OpenRead(srcFileName); 
   // Get the image dimension 
   CodecsImageInfo info = codecs.GetInformation(fs, false); 
   // Load the lower right corner of the image 
   LeadRect rc = new LeadRect( 
      info.Width / 2, 
      info.Height / 2, 
      info.Width / 2, 
      info.Height / 2); 
   RasterImage image = codecs.Load(fs, rc); 
   Debug.Assert(image.Width == (info.Width / 2)); 
   Debug.Assert(image.Height == (info.Height / 2)); 
   // Save this image back to disk 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24); 
   // Clean up 
static class LEAD_VARS 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 

Target Platforms

Help Version 22.0.2023.5.5
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Codecs Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.