DocumentProgressEventArgs Class

Summary

Provides data for the DocumentWriter.Progress event.

Syntax

C++

Java

public class DocumentProgressEventArgs : EventArgs

Public Class DocumentProgressEventArgs  
   Inherits System.EventArgs

public class DocumentProgressEvent extends LeadEvent

public ref class DocumentProgressEventArgs : public System.EventArgs

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:

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.

Example

For an example, refer to DocumentWriter.Progress.

Requirements

Target Platforms