Leadtools.Codecs Namespace > RasterCodecs Class > Load Method : Load(String) Method |
public RasterImage Load( string fileName )
'Declaration Public Overloads Function Load( _ ByVal fileName As String _ ) As RasterImage
'Usage Dim instance As RasterCodecs Dim fileName As String Dim value As RasterImage value = instance.Load(fileName)
public RasterImage Load( string fileName )
function Leadtools.Codecs.RasterCodecs.Load(String)( fileName )
public: RasterImage^ Load( String^ fileName )
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 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.
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
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"; }
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2