←Select platform

DocumentConverterJobOperation Enumeration

Summary

Document converter operation.

Syntax

C#
VB
Java
C++
[SerializableAttribute()] 
[DataContractAttribute()] 
public enum DocumentConverterJobOperation 
<SerializableAttribute(),  
 DataContractAttribute()>  
Public Enum DocumentConverterJobOperation 
public [SerializableAttribute,  
   DataContractAttribute] 
   enum class DocumentConverterJobOperation sealed 
public enum DocumentConverterJobOperation

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 Document 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:
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:
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)](../fo/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.
Remarks

Used as type for the following properties:

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.

Example

For an example, refer to RunJob and RunJobAsync.

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Documents.Converters Assembly
Introduction
Getting Started
Namespaces
Leadtools.Documents.Converters Namespace
Assemblies