DocumentConverterJobOperation Enumeration

Summary

Document converter operation.

Syntax

C++/CLI

Java

Python

[SerializableAttribute()] 
[DataContractAttribute()] 
public enum DocumentConverterJobOperation

public [SerializableAttribute,  
   DataContractAttribute] 
   enum class DocumentConverterJobOperation sealed

public enum DocumentConverterJobOperation

class DocumentConverterJobOperation(Enum): 
   Started = 0 
   Completed = 1 
   CreateDocument = 2 
   BeginDocumentWriter = 3 
   EndDocumentWriter = 4 
   Other = 5 
   LoadRasterPage = 6 
   SaveRasterPage = 7 
   LoadSvgPage = 8 
   AddDocumentPage = 9 
   PreprocessPage = 10 
   CreateOcrDocument = 11 
   AddOcrPage = 12 
   AutoZoneOcrPage = 13 
   RecognizeOcrPage = 14 
   SaveOcrPage = 15 
   SaveOcrDocument = 16 
   ConvertOcrDocument = 17 
   LoadAnnotations = 18 
   SaveAnnotations = 19 
   EmbedAnnotations = 20 
   ConvertDocument = 21 
   OverlayAnnotations = 22 
   BeginUploadDocument = 23 
   UploadDocument = 24 
   UploadAnnotations = 25 
   EndUploadDocument = 26 
   LinearizeDocument = 27 
   FillFormFields = 28

Members

0	Started	The conversion has started. Only with the DocumentConverterJobs.JobStarted event. Any errors that occur during this operation are critical.
1	Completed	The conversion has completed. Only with the DocumentConverterJobs.JobCompleted event. Any errors that occur during this operation are critical.
2	CreateDocument	A new LEADDocument object is created from InputDocumentFileName. Any errors that occur during this operation are critical.
3	BeginDocumentWriter	DocumentWriter.BeginDocument is called to create the output document. Document conversion only. Any errors that occur during this operation are critical. Override: When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.DocumentWriter will contain document writer to use to create the output document. The user can modify the options of this class if needed.
4	EndDocumentWriter	DocumentWriter.EndDocument is called to finalize the output document. Document conversion only. Any errors that occur during this operation are critical.
5	Other	General operation. Any errors that occur during this operation are critical.
6	LoadRasterPage	DocumentPage.GetImage is called get the raster image of a page. Document and Raster conversion. Any errors that occur during this operation are critical. Override: SVG conversion: When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.RasterImage will contain the overlay image to use if the output document format requires one. The user can modify this object if needed. OCR conversion: When DocumentConverterJobEventArgs.IsPostOperation is false, DocumentConverterJobEventArgs.OcrPageImage is null and will be loaded by the engine from the current document. The user override this behavior by setting their own value in DocumentConverterJobEventArgs.OcrPageImage and this image will be used for recognition. The engine will not dispose this image, it is the user's responsibility to perform this during the next event when DocumentConverterJobEventArgs.IsPostOperation is true. Raster conversion: When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.RasterImage will contain the raster image object to be added to the output document. The user can modify this object if needed.
7	SaveRasterPage	RasterCodecs.Save is called to save the page image. Raster conversion only. Any errors that occur during this operation are critical. Override: When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.RasterImage will contain the raster image object to be added to the output document. The user can modify this object if needed.
8	LoadSvgPage	DocumentPage.GetSvg is called get the SVG image of a page. Document conversion. Any errors that occur during this operation are critical. Override: When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.SvgDocument will contain the SVG document object to be added to the output document. The user can modify this object if needed.
9	AddDocumentPage	DocumentWriter.AddPage is called to add a page to the document. Document conversion. Any errors that occur during this operation are critical.
10	PreprocessPage	AutoPreprocess is called to pre-process the page. Document and Raster conversion. Any errors that occur during this operation are not critical. The error will be logged and pre-processing canceled. Override: SVG conversion: None. OCR conversion: DocumentConverterJobEventArgs.OcrPage will contain the page before and after it has been processed. Raster conversion: When DocumentConverterJobEventArgs.IsPostOperation is false, DocumentConverterJobEventArgs.RasterImage will contain the raster image object before it has been pre-processed. When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.RasterImage will contain the raster image object after it has been pre-processed. The user can modify either image if required.
11	CreateOcrDocument	CreateDocument object. Document conversion. Override (OCR conversion only): When DocumentConverterJobEventArgs.IsPostOperation is true, OcrDocument object used by this conversion. The user can modify this value if needed.
12	AddOcrPage	AddPage(RasterImage,OcrProgressCallback) object. Document conversion. Any errors that occur during this operation are critical.
13	AutoZoneOcrPage	IOcrPage.AutoZone is called. Document conversion. Any errors that occur during this operation are not critical. The error will be logged and a graphics zone is added to the page instead. The end result will be to not recognize this page, instead, add it as a raster page to the output document. Override (OCR conversion only): When DocumentConverterJobEventArgs.IsPostOperation is false, OcrPage to be zoned. if the user sets their own zone, then the engine will not perform auto-zoning automatically. When DocumentConverterJobEventArgs.IsPostOperation is true, OcrPage with the zones set. The user can modify this object if needed.
14	RecognizeOcrPage	IOcrPage.Recognize is called. Document conversion. Any errors that occur during this operation are not critical. The error will be logged. The raster image without recognition data will be added as is to the output document. Override (OCR conversion only): When DocumentConverterJobEventArgs.IsPostOperation is false, OcrPage to be recognized. if the user performs the recognition manually, then the engine will not recognize the page automatically. When DocumentConverterJobEventArgs.IsPostOperation is true, OcrPage with the current recognition data. The user can modify this object if needed.
15	SaveOcrPage	IOcrDocument.Save with a single page is called. Document conversion. Any errors that occur during this operation are critical.
16	SaveOcrDocument	IOcrDocument.Save is called. Document conversion. Any errors that occur during this operation are critical.
17	ConvertOcrDocument	DocumentWriter.Convert is during OCR conversion called. Document conversion. Any errors that occur during this operation are critical.
18	LoadAnnotations	AnnCodecs.Load is called to load the annotations from the input document or external input annotations file. Any errors that occur during this operation are not critical. The error will be logged. The annotations for the current page are ignored. Override: When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.AnnContainer will contain the annotation container to be used for this page and the user can modify this container if needed.
19	SaveAnnotations	AnnCodecs.Save is called to save the annotations to the external output annotations file. Any errors that occur during this operation are not critical. The error will be logged. The annotations for the current page are ignored. Override: When DocumentConverterJobEventArgs.IsPostOperation is false, DocumentConverterJobEventArgs.AnnContainer will contain the annotation container to be used for this page and the user can modify this container if needed.
20	EmbedAnnotations	The annotations are being embedded into the output document. Any errors that occur during this operation are not critical. The error will be logged. The annotations are not embedded and ignored. Override: When DocumentConverterJobEventArgs.IsPostOperation is false, DocumentConverterJobEventArgs.AnnContainer will contain the annotation container to be used for this page and the user can modify this container if needed.
21	ConvertDocument	DocumentWriter.Convert is called during SVG conversion. Document conversion. Any errors that occur during this operation are critical.
22	OverlayAnnotations	The annotations is being overlayed on top of the page.
23	BeginUploadDocument	The document converter is calling DocumentFactory.BeginUpload preparing to begin uploading the document to the cache.
24	UploadDocument	The document converter is calling DocumentFactory.UploadDocument to upload the document to the cache.
25	UploadAnnotations	The document converter is calling DocumentFactory.UploadAnnotations to upload the annotations of the document to the cache.
26	EndUploadDocument	The document converter is calling DocumentFactory.EndUpload to finish uploading the document to the cache.
27	LinearizeDocument	The document is a PDF and is being linearized (optimized for fast web viewing).
28	FillFormFields	Fill Form Fields

Remarks

Used as type for the following properties:

The DocumentConverterJobEventArgs.Operation property used with the DocumentConverterJobs.JobStarted, DocumentConverterJobs.JobOperation and DocumentConverterJobs.JobCompleted events. Specifies the current operation.
The DocumentConverterJobError.Operation property. Specifies the operation that caused the error.

When the value of DocumentConverterOptions.JobErrorMode is DocumentConverterJobErrorMode.Continue, then the engine can continue to work if an error occurred during specific operations. In the members table, each entry has a note that specifies whether errors occurring the operation is considered critical. Critical errors will cause the whole conversion process to fail and will never continue.

Requirements

Target Platforms

Reference

Leadtools.Document.Converter Namespace

Using LEADTOOLS Document Converter

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies