←Select platform

Progress Event

Summary

Event that occurs one or more times while the factory is loading the document to indicate the current progress.

Syntax
C#
VB
C++
public event EventHandler<LoadAsyncProgressEventArgs> Progress 
Public Event Progress As EventHandler(Of Leadtools.Document.LoadAsyncProgressEventArgs) 
public:  
   event EventHandler<Leadtools::Documents::LoadAsyncProgressEventArgs^>^ Progress 

Remarks

Progress will occur one or more times while the document is being loaded and it can be used to show a progress bar indicator for the user (and optionally, support for aborting the load). Progress uses the LoadAsyncProgressEventArgs event data class that is populated with the following for each "chunk":

Member Value
System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage Current progress percentage. This value goes from 0 to 100..
System.ComponentModel.ProgressChangedEventArgs.UserState The same value originally set by the user in LoadDocumentAsyncOptions.UserState.
Uri
The location of the document being loaded. This is the uri value passed to LoadFromUriAsync
BytesReceived
Number of bytes received during this chunk of the operation.
TotalBytesToReceive
Total number of bytes received so far for the whole load operation.
IsCancelPending
Can be used to abort the load operation.

Example

For an example, refer to DocumentFactory.LoadFromUriAsync.

Event Data

ParameterTypeDescription
senderobjectThe source of the event.
eLoadAsyncProgressEventArgsThe event data.

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly