Load(string) Method

Summary

Loads the specified image file using default options.

Syntax

Objective-C

C++

public RasterImage Load( 
   string fileName 
)

Public Overloads Function Load( _ 
   ByVal fileName As String _ 
) As RasterImage

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

public: 
RasterImage^ Load(  
   String^ fileName 
)

Parameters

fileName
A String containing the name of the image file 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 can load all the pages in a multipage file. For more information, refer to the last remark. 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.

The CodecsLoadOptions.AllPages property controls whether RasterCodecs will try to load all pages or just the first page if the image data contains multiple pages. To load a single page from a file, use Load(string fileName, int pageNumber).

Example

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

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
public void LoadFile1Example() 
{ 
	RasterCodecs codecs = new RasterCodecs(); 
	codecs.Options.Load.AllPages = true; 
	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:\LEADTOOLS21\Resources\Images"; 
}