Completed Event

Event that occurs when the factory finishes loading the document successfully or otherwise.

Syntax

C#
Visual Basic
Objective-C
Java
C++

public event EventHandler<LoadAsyncCompletedEventArgs> Completed

'Declaration

Public Event Completed As EventHandler(Of LoadAsyncCompletedEventArgs)

'Usage

Dim instance As LoadDocumentAsyncOptions
Dim handler As EventHandler(Of LoadAsyncCompletedEventArgs)
 
AddHandler instance.Completed, handler

public:
event EventHandler<LoadAsyncCompletedEventArgs^>^ Completed

Event Data

The event handler receives an argument of type LoadAsyncCompletedEventArgs containing data related to this event. The following LoadAsyncCompletedEventArgs properties provide information specific to this event.

Property	Description
Cancelled (Inherited from System.ComponentModel.AsyncCompletedEventArgs)	Gets a value indicating whether an asynchronous operation has been canceled.
Document	The loaded Document object.
Error (Inherited from System.ComponentModel.AsyncCompletedEventArgs)	Gets a value indicating which error occurred during an asynchronous operation.
Uri	The location of the document loaded.
UserState (Inherited from System.ComponentModel.AsyncCompletedEventArgs)	Gets the unique identifier for the asynchronous task.

Remarks

Completed will occur once when the factory finishes loading the document successfully or otherwise. It uses the LoadAsyncCompletedEventArgs event data class that is populated with the following:

Member	Value
Cancelled	true if the user has aborted the current operation, false otherwise. .
UserState	The same value originally set by the user in LoadDocumentAsyncOptions.UserState.
Error	The error object thrown if any.
Uri	The location of the document loaded. This is the uri value passed to LoadFromUriAsync
Document	The result Document object if the load operation was successful, null otherwise

Example

For an example, refer to DocumentFactory.LoadFromUriAsync.

Requirements

Target Platforms

Reference

LoadDocumentAsyncOptions Class
LoadDocumentAsyncOptions Members