Load(string,int) Method

Summary

Loads the specified page from an image file using default options.

Syntax

Objective-C

C++/CLI

Python

public RasterImage Load( 
   string fileName, 
   int pageNumber 
)

- (nullable LTRasterImage *)loadFile:(NSString *)file  
                          pageNumber:(NSInteger)pageNumber  
                               error:(NSError **)error

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

def Load(self,fileName,pageNumber):

Parameters

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

pageNumber
1-based index to the page number to load.

Return Value

The RasterImage object that this method loads.

Remarks

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

Use StartOptimizedLoad to speed up loading or converting multiple pages from the same source file.

Example

This example will query the number of pages from a disk file and then load them.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
public void LoadPagesFromFileTest(string fileName) 
{ 
   // Create a new RasterCodecs instance 
   using (RasterCodecs rasterCodecs = new RasterCodecs()) 
   { 
      rasterCodecs.GetFormat(fileName); 
      // Get the number of pages 
      int pageCount = rasterCodecs.GetTotalPages(fileName); 
      Debug.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)) 
         { 
            Debug.WriteLine("Page {0} loaded", pageNumber); 
         } 
      } 
   } 
}