|
Products | Support | Email a link to this topic. | Send comments on this topic. | Back to Introduction - All Topics | Help Version 19.0.4.3
|
| Leadtools.Documents.Converters Namespace > DocumentConverterJobs Class : JobStarted Event |
public event EventHandler<DocumentConverterJobEventArgs> JobStarted
'Declaration
Public Event JobStarted As EventHandler(Of DocumentConverterJobEventArgs)
'Usage
Dim instance As DocumentConverterJobs Dim handler As EventHandler(Of DocumentConverterJobEventArgs) AddHandler instance.JobStarted, handler
public void addJobStartedListener(DocumentConverterJobEventListener listener) public void removeJobStartedListener(DocumentConverterJobEventListener listener)
public: event EventHandler<DocumentConverterJobEventArgs^>^ JobStarted
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.
To abort pending jobs in a multi-threaded application using DocumentConverter, you subscribe to this event and set the value of Status to DocumentConverterJobStatus.Abort. You can also examine Job and only abort certain jobs depending on your application logic.
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.
For an example, refer to RunJob and RunJobAsync.
