DocumentConverterJobOperation Enumeration

Document converter operation.

Syntax

C#
Visual Basic
Objective-C
Java
C++

[DataContractAttribute()]
[SerializableAttribute()]
public enum DocumentConverterJobOperation : System.Enum

'Declaration

<DataContractAttribute()>
<SerializableAttribute()>
Public Enum DocumentConverterJobOperation 
   Inherits System.Enum

'Usage

Dim instance As DocumentConverterJobOperation

public enum DocumentConverterJobOperation

[DataContractAttribute()]
[SerializableAttribute()]
public enum class DocumentConverterJobOperation : public System.Enum

Members

Value	Member	Description
0x00000000	Started	The conversion has started. Only with the DocumentConverterJobs.JobStarted event.Any errors that occur during this operation are critical.
0x00000001	Completed	The conversion has completed. Only with the DocumentConverterJobs.JobCompleted event.Any errors that occur during this operation are critical.
0x00000002	CreateDocument	A new Document object is created from InputDocumentFileName.Any errors that occur during this operation are critical.
0x00000003	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.
0x00000004	EndDocumentWriter	DocumentWriter.EndDocument is called to finalize the output document. Document conversion only.Any errors that occur during this operation are critical.
0x00000005	Other	General operation.Any errors that occur during this operation are critical.
0x00000006	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 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.
0x00000007	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.
0x00000008	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.
0x00000009	AddDocumentPage	DocumentWriter.AddPage is called to add a page to the document. Document conversion.Any errors that occur during this operation are critical.
0x0000000A	PreprocessPage	IOcrPage.AutoPreprocess or DocumentConverterPreprocessor 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.
0x0000000B	CreateOcrDocument	IOcrDocumentManager.CreateDocument is called to create an IOcrDocument object. Document conversion.Override (OCR conversion only): When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.OcrDocument will contain the IOcrDocument object used by this conversion. The user can modify this value if needed.
0x0000000C	AddOcrPage	IOcrPageCollection.AddPage is called to add the IOcrPage object. Document conversion.Any errors that occur during this operation are critical.
0x0000000D	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, DocumentConverterJobEventArgs.OcrPage will contain IOcrPage to be zoned. if the user sets their own zone, then the engine will not perform auto-zoning automatically. When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.OcrPage will contain IOcrPage with the zones set. The user can modify this object if needed.
0x0000000E	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, DocumentConverterJobEventArgs.OcrPage will contain IOcrPage to be recognized. if the user performs the recognition manually, then the engine will not recognize the page automatically. When DocumentConverterJobEventArgs.IsPostOperation is true, DocumentConverterJobEventArgs.OcrPage will contain IOcrPage with the current recognition data. The user can modify this object if needed.
0x0000000F	SaveOcrPage	IOcrDocument.Save with a single page is called. Document conversion.Any errors that occur during this operation are critical.
0x00000010	SaveOcrDocument	IOcrDocument.Save is called. Document conversion.Any errors that occur during this operation are critical.
0x00000011	ConvertOcrDocument	DocumentWriter.Convert is during OCR conversion called. Document conversion.Any errors that occur during this operation are critical.
0x00000012	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.
0x00000013	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.
0x00000014	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.
0x00000015	ConvertDocument	DocumentWriter.Convert is called during SVG conversion. Document conversion.Any errors that occur during this operation are critical.
0x00000016	OverlayAnnotations	The annotations is being overlayed on top of the page.

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.

Example

For an example, refer to RunJob and RunJobAsync.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         Leadtools.Documents.Converters.DocumentConverterJobOperation

Requirements

Target Platforms

Reference

Leadtools.Documents.Converters Namespace
Using LEADTOOLS Document Converters