LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
Load(String,LeadRect) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > Load Method : Load(String,LeadRect) Method



fileName
A System.String containing the name of the image file to load.
tile
A Leadtools.LeadRect describing the tile/area of the image to load.
fileName
A System.String containing the name of the image file to load.
tile
A Leadtools.LeadRect describing the tile/area of the image to load.
Loads the specified rectangle from the specified image file using default options.

Syntax

Visual Basic (Declaration) 
Overloads Public Function Load( _
   ByVal fileName As String, _
   ByVal tile As LeadRect _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim fileName As String
Dim tile As LeadRect
Dim value As RasterImage
 
value = instance.Load(fileName, tile)
C# 
public RasterImage Load( 
   string fileName,
   LeadRect tile
)
C++/CLI 
public:
RasterImage^ Load( 
   String^ fileName,
   LeadRect tile
) 

Parameters

fileName
A System.String containing the name of the image file to load.
tile
A Leadtools.LeadRect describing the tile/area of the image to load.

Return Value

The Leadtools.RasterImage object that this method loads.

Example

This example will create a rectangle area from an image on disk.

Visual BasicCopy Code
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)
      image.Dispose()

      ' Clean up
      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
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);
      image.Dispose();

      // Clean up
      codecs.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
SilverlightVBCopy Code

Remarks

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 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: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also