Load(String,Int32) Method

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public RasterImage Load( 
   string fileName,
   int pageNumber
)

'Declaration
 
Public Overloads Function Load( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer _
) As RasterImage

'Usage
 
Dim instance As RasterCodecs
Dim fileName As String
Dim pageNumber As Integer
Dim value As RasterImage
 
value = instance.Load(fileName, pageNumber)

public RasterImage Load( 
   string fileName,
   int pageNumber
)

 function Leadtools.Codecs.RasterCodecs.Load(String,Int32)( 
   fileName ,
   pageNumber 
)

public:
RasterImage^ Load( 
   String^ fileName,
   int pageNumber
)

Parameters

fileName: A System.String containing the name of the image file to load.
pageNumber: 1-based index to the page number to load.

Return Value

The Leadtools.RasterImage object that this method loads.

The file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.

This method will load a single page from 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 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 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.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing
Imports Leadtools.ImageProcessing.Color
Imports Leadtools.Drawing

Private Shared Sub LoadPagesFromFileTest(fileName As String)
   ' Create a new RasterCodecs instance
   Using rasterCodecs As New RasterCodecs()
      ' Get the number of pages
      Dim pageCount As Integer = rasterCodecs.GetTotalPages(fileName)
      Console.WriteLine("Number of pages in the file is {0}", pageCount)
      ' Load all pages
      For pageNumber As Integer = 1 To pageCount
         Using rasterImage As RasterImage = rasterCodecs.Load(fileName, pageNumber)
            Console.WriteLine("Page {0} loaded", pageNumber)
         End Using
      Next
   End Using
End Sub

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing;
using Leadtools.ImageProcessing.Color;

private static void LoadPagesFromFileTest(string fileName)
{
   // Create a new RasterCodecs instance
   using (RasterCodecs rasterCodecs = new RasterCodecs())
   {
      // Get the number of pages
      int pageCount = rasterCodecs.GetTotalPages(fileName);
      Console.WriteLine("Number of pages in the file is {0}", pageCount);
      // Load all pages
      for (int pageNumber = 1; pageNumber <= pageCount; pageNumber++)
      {
         using (RasterImage rasterImage = rasterCodecs.Load(fileName, pageNumber))
         {
            Console.WriteLine("Page {0} loaded", pageNumber);
         }
      }
   }
}

Target Platforms

Reference

RasterCodecs Class
RasterCodecs Members
Overload List
Loading and Saving Images
Loading and Saving Large Tiff Files
Speeding Up 1-Bit Documents
Fast File Info