Loads the specified image stream using default options.
public RasterImage Load(
Stream stream
)
Public Overloads Function Load( _
ByVal stream As Stream _
) As RasterImage
- (nullable LTRasterImage *)loadStream:(LTLeadStream *)stream
error:(NSError **)error;
public RasterImage load(ILeadStream stream)
public:
RasterImage^ Load(
Stream^ stream
)
stream
A Stream containing the image data to load.
The RasterImage object that this method loads.
The stream can point to 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 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.
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 stream, use Load(Stream stream, int pageNumber).
This example will load all the pages from a stream that contains a single multipage file
using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing;
using Leadtools.ImageProcessing.Color;
using Leadtools.Svg;
using LeadtoolsExamples.Common;
public void LoadStream1Example()
{
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");
// Load the file into a stream
FileStream fs = File.OpenRead(singlePageFileName);
// Get the file information (we are interested in the number of pages)
CodecsImageInfo info = codecs.GetInformation(fs, 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(fs);
Console.WriteLine("Number of pages loaded: {0}", image.PageCount);
Debug.Assert(image.PageCount == info.TotalPages);
image.Dispose();
fs.Close();
// Repeat for a multipage file
fs = File.OpenRead(multiPageFileName);
info = codecs.GetInformation(fs, true);
Console.WriteLine("Number of pages according to info: {0}", info.TotalPages);
image = codecs.Load(fs);
Console.WriteLine("Number of pages loaded: {0}", image.PageCount);
Debug.Assert(image.PageCount == info.TotalPages);
image.Dispose();
fs.Close();
// Clean up
codecs.Dispose();
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing
Imports Leadtools.ImageProcessing.Color
Imports Leadtools.Drawing
Imports Leadtools.Svg
Public Sub LoadStream1Example()
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")
' Load the file into a stream
Dim fs As FileStream = File.OpenRead(singlePageFileName)
' Get the file information (we are interested in the number of pages)
Dim info As CodecsImageInfo = codecs.GetInformation(fs, 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(fs)
Console.WriteLine("Number of pages loaded: {0}", image.PageCount)
Debug.Assert(image.PageCount = info.TotalPages)
image.Dispose()
fs.Close()
' Repeat for a multipage file
fs = File.OpenRead(multiPageFileName)
info = codecs.GetInformation(fs, True)
Console.WriteLine("Number of pages according to info: {0}", info.TotalPages)
image = codecs.Load(fs)
Console.WriteLine("Number of pages loaded: {0}", image.PageCount)
Debug.Assert(image.PageCount = info.TotalPages)
image.Dispose()
fs.Close()
' Clean up
codecs.Dispose()
End Sub
Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
c#[Silverlight C# Example]
using Leadtools;
using Leadtools.Codecs;
using Leadtools.Examples;
using Leadtools.ImageProcessing;
using Leadtools.ImageProcessing.Color;
using Leadtools.Windows.Media;
public void LoadStream1Example(Stream inStreamSingleCmp, Stream inStreamMultiGif)
{
RasterCodecs codecs = new RasterCodecs();
// Get the file information (we are interested in the number of pages)
CodecsImageInfo info = codecs.GetInformation(inStreamSingleCmp, true);
Debug.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(inStreamSingleCmp);
Debug.WriteLine("Number of pages loaded: {0}", image.PageCount);
Debug.Assert(image.PageCount == info.TotalPages);
image.Dispose();
// Repeat for a multipage file
info = codecs.GetInformation(inStreamMultiGif, true);
Debug.WriteLine("Number of pages according to info: {0}", info.TotalPages);
image = codecs.Load(inStreamMultiGif);
Debug.WriteLine("Number of pages loaded: {0}", image.PageCount);
Debug.Assert(image.PageCount == info.TotalPages);
image.Dispose();
}
vb[Silverlight VB Example]
Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing
Imports Leadtools.ImageProcessing.Color
Imports Leadtools.Windows.Media
Public Sub LoadStream1Example(ByVal inStreamSingleCmp As Stream, ByVal inStreamMultiGif As Stream)
Dim codecs As RasterCodecs = New RasterCodecs()
' Get the file information (we are interested in the number of pages)
Dim info As CodecsImageInfo = codecs.GetInformation(inStreamSingleCmp, True)
Debug.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(inStreamSingleCmp)
Debug.WriteLine("Number of pages loaded: {0}", image.PageCount)
Debug.Assert(image.PageCount = info.TotalPages)
image.Dispose()
' Repeat for a multipage file
info = codecs.GetInformation(inStreamMultiGif, True)
Debug.WriteLine("Number of pages according to info: {0}", info.TotalPages)
image = codecs.Load(inStreamMultiGif)
Debug.WriteLine("Number of pages loaded: {0}", image.PageCount)
Debug.Assert(image.PageCount = info.TotalPages)
image.Dispose()
End Sub
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document