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




fileName
A String containing the name of the image file to load.
tile
A Rectangle 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 Rectangle _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim fileName As String
Dim tile As Rectangle
Dim value As RasterImage
 
value = instance.Load(fileName, tile)
C# 
public RasterImage Load( 
   string fileName,
   Rectangle tile
)
Managed Extensions for C++ 
public: RasterImage Load( 
   string* fileName,
   Rectangle tile
)
C++/CLI 
public:
RasterImage Load( 
   String^ fileName,
   Rectangle tile
)

Parameters

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

Return Value

The RasterImage object that this method loads.

Example

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

         Dim srcFileName As String = "C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Image1.cmp"
         Dim destFileName As String = "C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\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 Rectangle = New Rectangle(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()
         RasterCodecs.Shutdown()
      End Sub
C#Copy Code
RasterCodecs.Load(string, Rectangle) 
      public void LoadTileFile1Example() 
      { 
         RasterCodecs.Startup(); 
         RasterCodecs codecs = new RasterCodecs(); 
 
         string srcFileName = @"C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Image1.cmp"; 
         string destFileName = @"C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Image1_LoadTileFile1.bmp"; 
 
         // Get the image dimension 
         CodecsImageInfo info = codecs.GetInformation(srcFileName, false); 
 
         // Load the lower right corner of the image 
         Rectangle rc = new Rectangle( 
            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(); 
         RasterCodecs.Shutdown(); 
      }

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: 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