JobCompleted Event

C#
Visual Basic
Objective-C
Java
C++

public event EventHandler<DocumentConverterJobEventArgs> JobCompleted

'Declaration

Public Event JobCompleted As EventHandler(Of DocumentConverterJobEventArgs)

'Usage

Dim instance As DocumentConverterJobs
Dim handler As EventHandler(Of DocumentConverterJobEventArgs)
 
AddHandler instance.JobCompleted, handler

public void addJobCompletedListener(DocumentConverterJobEventListener listener)
public void removeJobCompletedListener(DocumentConverterJobEventListener listener)

public:
event EventHandler<DocumentConverterJobEventArgs^>^ JobCompleted

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

Property	Description
AnnContainer	The AnnContainer object used when annotations are loaded or saved.
AnnotationsMode	Current annotations mode.
Document	The current input Document object.
DocumentWriter	The DocumentWriter object used when saving document formats.
InputDocumentPageNumber	The current input page number.
IsPostOperation	A value that indicates whether the engine has already run the operation.
Job	The current job object.
OcrDocument	The IOcrDocument object created when converting using OCR.
OcrPage	The IOcrPage object created when converting using OCR.
OcrPageImage	RasterImage object used as the input for a page when OCR conversion is used.
Operation	The current operation.
OutputDocumentPageNumber	The current output page number.
RasterImage	The RasterImage object used as the input for raster conversion and optional overlay for SVG conversion.
Status	Current status of the job and allows the user to cancel it.
SvgDocument	The SvgDocument object used when SVG conversion is used.

This event will occur when RunJob or RunJobAsync is finished running.

You can use this event to keep track of the number of jobs pending running. You can also examine DocumentConverterJobEventArgs.Job to get information on whether job finished successfully and get error status if any. RunJob example shows complete source code of how to easily accomplish these tasks in your application.

The JobStarted will occur exactly once per job. DocumentConverterJobEventArgs.IsPostOperation will always be false.

The JobCompleted event will always occur when a job is finished running whether the job is aborted or completed.

The JobStarted event occurs when a job is about to start.

For an example, refer to RunJob and RunJobAsync.

Target Platforms

Reference

DocumentConverterJobs Class
DocumentConverterJobs Members
Using LEADTOOLS Document Converters