←Select platform

Load(string,LeadRect) Method


Loads the specified rectangle from the specified image file using default options.

public RasterImage Load( 
   string fileName, 
   LeadRect tile 
Public Overloads Function Load( _ 
   ByVal fileName As String, _ 
   ByVal tile As LeadRect _ 
) As RasterImage 
RasterImage^ Load(  
   String^ fileName, 
   LeadRect tile 


A String containing the name of the image file 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 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 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 an image on disk.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
public void LoadTileFile1Example() 
   RasterCodecs codecs = new RasterCodecs(); 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_LoadTileFile1.bmp"); 
   // Get the image dimension 
   CodecsImageInfo info = codecs.GetInformation(srcFileName, 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(srcFileName, 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:\Users\Public\Documents\LEADTOOLS Images"; 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
Public Sub LoadTileFile1Example() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp") 
   Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_LoadTileFile1.bmp") 
   ' Get the image dimension 
   Dim info As CodecsImageInfo = codecs.GetInformation(srcFileName, False) 
   ' Load the lower right corner of the image 
   Dim rc As LeadRect = New LeadRect(info.Width \ 2, info.Height \ 2, info.Width \ 2, info.Height \ 2) 
   Dim image As RasterImage = codecs.Load(srcFileName, 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 
End Sub 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 


Target Platforms

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

Leadtools.Codecs Assembly