The DocumentProgressEventArgs Class is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.
Provides data for the DocumentWriter.Progress event.
Object Model
Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Class DocumentProgressEventArgs Inherits System.EventArgs | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As DocumentProgressEventArgs | |
| C# | |
|---|---|
public class DocumentProgressEventArgs : System.EventArgs | |
| C++/CLI | |
|---|---|
public ref class DocumentProgressEventArgs : public System.EventArgs | |
Example
For an example, refer to DocumentWriter.Progress.
Remarks
The DocumentWriter.Progress event allows you to monitor the progress of a document writer operation as well as cancel the operation if required. This event occur when calling the following methods of the DocumentWriter class:
- DocumentWriter.BeginDocument
- DocumentWriter.AddPage
- DocumentWriter.EndDocument
- DocumentWriter.Convert
The DocumentProgressEventArgs class contains the following:
- DocumentProgressEventArgs.Percentage property. The value of this property will go from 0 to 100 during an operation. This property is read-only.
- DocumentProgressEventArgs.Cancel property. Setting the value of this property to true will cancel the current operation.
Inheritance Hierarchy
System.Object
System.EventArgs
Leadtools.Forms.DocumentWriters.DocumentProgressEventArgs
Requirements
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7