Load(Uri) Method

Summary

Loads the specified image URL using default options.

Syntax

C++

public RasterImage Load( 
   Uri uri 
)

Public Overloads Function Load( _ 
   ByVal uri As Uri _ 
) As RasterImage

public: 
RasterImage^ Load(  
   Uri^ uri 
)

Parameters

uri
The Uri containing the input image data.

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.

LEADTOOLS supports the following URI schemes:

Scheme	Description
UriSchemeFile	Specifies that the URI is a disk file in local machine or universal naming convention (UNC) path.
UriSchemeHttp	Specifies that the URI is accessed through the Hypertext Transfer Protocol (HTTP).
UriSchemeHttps	Specifies that the URI is accessed through the Secure Hypertext Transfer Protocol (HTTPS).
UriSchemeFtp	Specifies that the URI is accessed through the File Transfer Protocol (FTP).

If uri points to a resource in a UriSchemeHttp, UriSchemeHttps or UriSchemeFtp, then this RasterCodecs will attempt to download image data in an iterative fashion by creating a temporary buffer. The size of this buffer can be determined and changed by setting up the UriOperationBufferSize prior to calling this method.

For authenticity and proxy settings, refer to UriOperationCredentials and UriOperationProxy.

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 URI, use Load(Uri uri, int pageNumber).

Example

This example will load an image from a uri

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
public void LoadUri1Example() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   Uri uri = new Uri(@"https://www.leadtools.com/images/page_graphics/leadlogo.png"); 
   RasterImage image = codecs.Load(uri); 
 
   // Show information about tha image 
   Console.WriteLine("Size: {0} by {1} pixels", image.Width, image.Height); 
   Console.WriteLine("Bits/Pixel: {0}", image.BitsPerPixel); 
   image.Dispose(); 
 
   // Clean up 
   codecs.Dispose(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub LoadUri1Example() 
   Dim codecs As New RasterCodecs() 
 
   Dim uri As New Uri("https://www.leadtools.com/images/15-homepg-banner.jpg") 
   Dim image As RasterImage = codecs.Load(uri) 
 
   ' Show information about tha image 
   Console.WriteLine("Size: {0} by {1} pixels", image.Width, image.Height) 
   Console.WriteLine("Bits/Pixel: {0}", image.BitsPerPixel) 
   image.Dispose() 
 
   ' Clean up 
   codecs.Dispose() 
End Sub