LoadSvgAsync(string,int,CodecsLoadSvgOptions,object) Method

Summary

Loads a page from an image, document or vector file as SVG asynchronously.

Syntax

Objective-C

C++

public void LoadSvgAsync( 
   string fileName, 
   int pageNumber, 
   CodecsLoadSvgOptions options, 
   object userState 
)

Public Overloads Sub LoadSvgAsync( _ 
   ByVal fileName As String, _ 
   ByVal pageNumber As Integer, _ 
   ByVal options As CodecsLoadSvgOptions, _ 
   ByVal userState As Object _ 
)

- (void)loadSvgFileAsync:(NSString *)file  
                    page:(NSInteger)pageNumber  
                 options:(nullable LTCodecsLoadSvgOptions *)options  
              completion:(void (^)(id<ISvgDocument> __nullable svgDocument, NSError * __nullable error))completion

public: 
void LoadSvgAsync(  
   String^ fileName, 
   int pageNumber, 
   CodecsLoadSvgOptions^ options, 
   Object^ userState 
)

Parameters

fileName
A String containing the name of the image file to load.

pageNumber
The 1-based page number.

options
The options used for loading SVG. This can be null.

userState
A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Remarks

NOTE: This topic is part of RasterCodecs Async support using the .NET System.ComponentMode.AsyncOperation model. For .NET async/await, use Task<ISvgDocument> LoadSvgAsync(ILeadStream stream, int pageNumber, CodecsLoadSvgOptions options).

Use this method to load a page from any supported image, document or vector file as SVG (Scalable Vector Graphics). For more information refer LoadSvg(string fileName, int pageNumber, CodecsLoadSvgOptionsOptions).

The RasterCodecs class supports loading image data as SVG asynchronously using the LoadSvgAsync methods. When calling any of these methods, the caller thread will not be blocked and the method will return instantly. When the RasterCodecs object finishes loading the SVG page (or when an error occur), the LoadSvgAsyncCompleted will occur.

The LoadSvgAsyncCompleted event data will contain the SVG page in the CodecsLoadSvgAsyncCompletedEventArgs property.

To determine whether a file or stream can be loaded as SVG, use CanLoadSvg(string fileName) or CanLoadSvg(Stream stream).

To load as SVG asynchronously from a stream, use LoadSvgAsync(Stream stream, int pageNumber, CodecsLoadSvgOptions options, object userState).

To load as SVG asynchronously from a URI, use LoadSvgAsync(Uri uri, int pageNumber, CodecsLoadSvgOptions options, object userState).

To load as SVG from a file or stream directly, use LoadSvg.

For more information, refer to Working With SVG.

Example

For an example, refer to LoadSvgAsyncCompleted.

Requirements

Target Platforms