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) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > Load Method : Load(String) Method



fileName
A System.String containing the name of the image file to load.
fileName
A System.String containing the name of the image file to load.
Loads the specified image file using default options.

Syntax

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

Parameters

fileName
A System.String containing the name of the image file to load.

Return Value

The Leadtools.RasterImage object that this method loads.

Example

This example will load all the pages from a single multipage file

Visual BasicCopy Code
Public Sub LoadFile1Example()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim singlePageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
      Dim multiPageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "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()
   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 LoadFile1Example()
   {
      RasterCodecs codecs = new RasterCodecs();

      string singlePageFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");
      string multiPageFileName = Path.Combine(LEAD_VARS.ImagesDir, "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();
   }

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

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

See Also