|
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 : JobOperation Event |
public event EventHandler<DocumentConverterJobEventArgs> JobOperation
'Declaration
Public Event JobOperation As EventHandler(Of DocumentConverterJobEventArgs)
'Usage
Dim instance As DocumentConverterJobs Dim handler As EventHandler(Of DocumentConverterJobEventArgs) AddHandler instance.JobOperation, handler
public void addJobOperationListener(DocumentConverterJobEventListener listener) public void removeJobOperationListener(DocumentConverterJobEventListener listener)
public: event EventHandler<DocumentConverterJobEventArgs^>^ JobOperation
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 one or more times will occur while RunJob or RunJobAsync is running.
You can use this event to get information on the current operation (loading a page, converting, saving, etc.).
The values of DocumentConverterJobEventArgs depend on the current operation. You can modify these values at certain operations to alter or override the behavior or data of the conversion process. Refer to DocumentConverterJobOperation for more information.
The JobOperation event occurs twice per operation. First with DocumentConverterJobEventArgs.IsPostOperation set to false to indicate that the operation is about to happen. then with DocumentConverterJobEventArgs.IsPostOperation set to true to indicate that the operation was performed.
The JobStarted event occurs when a job is about to start.
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.
