Manages the extra options to use with the document converter.
public class DocumentConverterOptions
Public Class DocumentConverterOptions
public ref class DocumentConverterOptions
public class DocumentConverterOptions
DocumentConverterOptions manages the extra options to use with the document converter and can be accessed through the Options property of DocumentConverter.
This class contains the following members:
Member | Description |
---|---|
JobErrorMode |
Ability to resume on none critical errors. |
PageNumberingTemplate |
Template to use for the individual file names when the output format does not support multipages. |
OutputSinglePages |
Force outputting single page files even if the format supports multipage. For raster conversion only. |
EnableSvgConversion |
Use SVG conversion when supported. |
SvgImagesRecognitionMode |
Determines how to treat any image elements encountered in an input SVG page during the conversion. |
EmptyPageMode |
Determines how empty pages are treated during the conversion. |
UseThreads |
Indicates whether to use multiple threads during the conversion. |
DocumentConverterOptions supports saving and loading the options to a stream or string using:
Method | Description |
---|---|
Save | Saves the current option to a stream as XML. |
SaveToString | Gets the current options as an XML string. |
Load | Loads the options previously saved from an XML stream. |
LoadFromString | Sets the options from an XML string. |
using Leadtools;
using Leadtools.Codecs;
using Leadtools.Document.Writer;
using Leadtools.Svg;
using LeadtoolsExamples.Common;
using Leadtools.Document;
using Leadtools.Caching;
using Leadtools.Annotations.Engine;
using Leadtools.Ocr;
using Leadtools.Document.Converter;
public void DocumentConverterOptionsExample()
{
using (DocumentConverter documentConverter = new DocumentConverter())
{
//use options to force ocr conversion (disable SVG)
documentConverter.Options.EnableSvgConversion = false;
//abort job at first error (in any page)
documentConverter.Options.JobErrorMode = DocumentConverterJobErrorMode.Abort;
var ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD, false);
var rasterCodecs = new RasterCodecs();
var documentWriter = new DocumentWriter();
ocrEngine.Startup(rasterCodecs, documentWriter, null, LEAD_VARS.OcrLEADRuntimeDir);
documentConverter.SetOcrEngineInstance(ocrEngine, true);
documentConverter.Diagnostics.EnableTrace = true;
var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.docx");
var outFile = Path.Combine(ImagesPath.Path, @"output.pdf");
var format = DocumentFormat.Pdf;
var jobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format);
jobData.JobName = "conversion job";
var job = documentConverter.Jobs.CreateJob(jobData);
documentConverter.Jobs.RunJob(job);
if (job.Status == DocumentConverterJobStatus.Success)
{
Console.WriteLine("Success");
}
else
{
Console.WriteLine("{0} Errors", job.Status);
foreach (var error in job.Errors)
{
Console.WriteLine(" {0} at {1}: {2}", error.Operation, error.InputDocumentPageNumber, error.Error.Message);
}
}
}
}
static class LEAD_VARS
{
public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS 20\Bin\Common\OcrLEADRuntime";
}
Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.Document.Writer
Imports Leadtools.Svg
Imports Leadtools.Document
Imports Leadtools.Caching
Imports Leadtools.Annotations.Engine
Imports Leadtools.Ocr
Imports Leadtools.Document.Converter
Imports LeadtoolsDocumentConverterExamples.LeadtoolsExamples.Common
Public Sub DocumentConverterOptionsExample()
Using documentConverter As New DocumentConverter()
'use options to force ocr conversion (disable SVG)
documentConverter.Options.EnableSvgConversion = False
'abort job at first error (in any page)
documentConverter.Options.JobErrorMode = DocumentConverterJobErrorMode.Abort
Dim ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD, False)
Dim rasterCodecs As RasterCodecs = New RasterCodecs()
Dim documentWriter As DocumentWriter = New DocumentWriter()
ocrEngine.Startup(rasterCodecs, documentWriter, Nothing, LEAD_VARS.OcrLEADRuntimeDir)
documentConverter.SetOcrEngineInstance(ocrEngine, True)
documentConverter.Diagnostics.EnableTrace = True
Dim inFile As String = Path.Combine(ImagesPath.Path, "Leadtools.docx")
Dim outFile As String = Path.Combine(ImagesPath.Path, "output.pdf")
Dim format As DocumentFormat = DocumentFormat.Pdf
Dim jobData As DocumentConverterJobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format)
jobData.JobName = "conversion job"
Dim job As DocumentConverterJob = documentConverter.Jobs.CreateJob(jobData)
documentConverter.Jobs.RunJob(job)
If job.Status = DocumentConverterJobStatus.Success Then
Console.WriteLine("Success")
Else
Console.WriteLine("{0} Errors", job.Status)
For Each errorItem As DocumentConverterJobError In job.Errors
Console.WriteLine(" {0} at {1}: {2}", errorItem.Operation, errorItem.InputDocumentPageNumber, errorItem.Error.Message)
Next
End If
End Using
End Sub
Public NotInheritable Class LEAD_VARS
Public Const OcrLEADRuntimeDir As String = "C:\LEADTOOLS 20\Bin\Common\OcrLEADRuntime"
End Class
DocumentConverterOptions Members
Leadtools.Document.Converter Namespace
Using LEADTOOLS Document Converters
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document
Your email has been sent to support! Someone should be in touch! If your matter is urgent please come back into chat.
Chat Hours:
Monday - Friday, 8:30am to 6pm ET
Thank you for your feedback!
Please fill out the form again to start a new chat.
All agents are currently offline.
Chat Hours:
Monday - Friday
8:30AM - 6PM EST
To contact us please fill out this form and we will contact you via email.