LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
LoadAsync(Uri,Object) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > LoadAsync Method : LoadAsync(Uri,Object) Method



uri
The System.Uri containing the input image data.
userState
A user-defined object that is passed to the method invoked when the asynchronous operation completes.
uri
The System.Uri containing the input image data.
userState
A user-defined object that is passed to the method invoked when the asynchronous operation completes.
Loads the specified image URL using default options asynchronously.

Syntax

Visual Basic (Declaration) 
Overloads Public Function LoadAsync( _
   ByVal uri As Uri, _
   ByVal userState As Object _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim uri As Uri
Dim userState As Object
Dim value As RasterImage
 
value = instance.LoadAsync(uri, userState)
C# 
public RasterImage LoadAsync( 
   Uri uri,
   object userState
)
C++/CLI 
public:
RasterImage^ LoadAsync( 
   Uri^ uri,
   Object^ userState
) 

Parameters

uri
The System.Uri containing the input image data.
userState
A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Return Value

The Leadtools.RasterImage object that this method loads. See remarks for the usage of this object.

Example

For an example, refer to LoadAsyncCompleted.

Remarks

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 options parameters before calling this method.

Support for 12 and 16-bit grayscale 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.

LEADTOOLS supports the following URI schemes:

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

If uri points to a resource in a System.Uri.UriSchemeHttp, System.Uri.UriSchemeHttps or System.Uri.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 authentical and proxy settings, refer to UriOperationCredentials and UriOperationProxy.

The RasterCodecs class supports loading image files asynchronously using the LoadAsync methods. When calling any of these methods, the caller thread will not be blocked and the method will return instantly with an instance Leadtools.RasterImage that is in a loading status (RasterImage.IsLoading set to true). You should not use the other properties of this object while the object is in loading status.

When the RasterCodecs object finishes loading the image, the various properties of the Leadtools.RasterImage will be populated with the image information and data and the RasterImage.IsLoading property will be set to false.

It is recommended that you do not poll for the RasterImage.IsLoading property to check when the image is finished loaded, instead, subscribe to the LoadAsyncCompleted event to get notification on when the RasterCodecs.LoadAsync operation is completed and if any errors occurred.

The LoadAsyncCompleted event data will also contain the same object returned from LoadAsync so you do not have to keep the original object in your application.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also