Load(Stream,int) Method

Summary

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

Syntax

Objective-C

C++

Java

public RasterImage Load( 
   Stream stream, 
   int pageNumber 
)

Public Overloads Function Load( _ 
   ByVal stream As Stream, _ 
   ByVal pageNumber As Integer _ 
) As RasterImage

- (nullable LTRasterImage *)loadStream:(LTLeadStream *)stream  
                            pageNumber:(NSInteger)pageNumber  
                                 error:(NSError **)error

public RasterImage load(ILeadStream stream, int PageNumber)

public: 
RasterImage^ Load(  
   Stream^ stream, 
   int pageNumber 
)

Parameters

stream
A Stream containing the image data to load.

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

Return Value

The RasterImage object that this method loads.

Remarks

The stream can point to 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 stream.

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 URI and then load them.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
private static void LoadPagesFromStreamTest(Stream stream) 
{ 
   // Create a new RasterCodecs instance 
   using (RasterCodecs rasterCodecs = new RasterCodecs()) 
   { 
      // Get the number of pages 
      int pageCount = rasterCodecs.GetTotalPages(stream); 
      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(stream, pageNumber)) 
         { 
            Console.WriteLine("Page {0} loaded", pageNumber); 
         } 
      } 
   } 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Private Shared Sub LoadPagesFromStreamTest(stream As Stream) 
   ' Create a new RasterCodecs instance 
   Using rasterCodecs As New RasterCodecs() 
      ' Get the number of pages 
      Dim pageCount As Integer = rasterCodecs.GetTotalPages(stream) 
      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(stream, pageNumber) 
            Console.WriteLine("Page {0} loaded", pageNumber) 
         End Using 
      Next 
   End Using 
End Sub