LoadAsyncProgressEventArgs Class

Summary

Data for the LoadDocumentAsyncOptions.Progress event.

Syntax

C++/CLI

Python

public class LoadAsyncProgressEventArgs : ProgressChangedEventArgs

public ref class LoadAsyncProgressEventArgs : System::ComponentModel::ProgressChangedEventArgs

class LoadAsyncProgressEventArgs(ProgressChangedEventArgs):

Remarks

LoadAsyncProgressEventArgs derives from System.ComponentModel.ProgressChangedEventArgs and contains the following members:

Member	Description
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

using Leadtools; 
using Leadtools.Caching; 
using Leadtools.Document; 
 
 
public void DocumentFactoryLoadFromUriAsyncExample() 
{ 
   AutoResetEvent finished = null; 
   EventHandler<LoadAsyncCompletedEventArgs> completed = null; 
   // LoadAsyncProgressEventArgs reference 
   EventHandler<LoadAsyncProgressEventArgs> progress = null; 
 
   completed = (sender, e) => 
   { 
      //Assert((int)e.UserState == 1); 
 
      if (e.Cancelled) 
         Console.WriteLine("Canceled"); 
      if (e.Error != null) 
         Console.WriteLine("Error:" + e.Error.Message); 
      if (e.Document == null) 
         Console.WriteLine("Document is null"); 
 
      var thisOptions = sender as LoadDocumentAsyncOptions; 
      thisOptions.Completed -= completed; 
 
      if (e.Document != null) 
      { 
         PrintOutDocumentInfo(e.Document); 
      } 
 
      finished.Set(); 
      Console.WriteLine("Done"); 
   }; 
 
   progress = (sender, f) => 
   { 
      Console.WriteLine(f.BytesReceived); 
      Console.WriteLine(f.IsCancelPending); 
      Console.WriteLine(f.TotalBytesToReceive); 
 
      var thisOptions = sender as LoadDocumentAsyncOptions; 
      thisOptions.Progress -= progress; 
   }; 
 
   var options = new LoadDocumentAsyncOptions(); 
   options.Completed += completed; 
 
   finished = new AutoResetEvent(false); 
   DocumentFactory.LoadFromUriAsync(new Uri("http://localhost/Leadtools.pdf"), options); 
   finished.WaitOne(); 
}

Requirements

Target Platforms

Reference

LoadAsyncProgressEventArgs Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 22.0.2023.4.21

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies