OutputFiles Property

Summary

Output files generated by this conversion job.

Syntax

C++/CLI

Java

Python

public IList<string> OutputFiles { get; }

public:  
   property System::Collections::Generic::IList<String^>^ OutputFiles 
   { 
      System::Collections::Generic::IList<String^>^ get() 
   }

public List<String> getOutputFiles()

OutputFiles # get  (DocumentConverterJob)

Property Value

A list that contains the full paths of all output files generated by this conversion job.

Remarks

This list contains one or more of the following:

If the output format supports multipage formats, then this list will contain the document file name (DocumentConverterJobData.OutputDocumentFileName
Otherwise, the list will contain the output files generated using PageNumberingTemplate
Some output formats will generate more than one file by default (for example, HTML if the input document contains images). All these files are added to OutputFiles.
DocumentConverterJobData.OutputAnnotationsFileName if the annotation mode was set to create an external file.

OutputDocumentFiles will contain the subset of OutputFiles containing the name of the files that belong to the final document, OutputDocumentExtraFileswill contain the subset of OutputFiles containing the name of the extra files that belong to the final document (resources for HTML for instance) and OutputAnnotationFiles will contain the subset of OutputFiles containing the name of the files that belong to annotations (if any).

Example

Java

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; 
using Leadtools.Annotations.Rendering; 
 
public void DocumentConverterOutputFilesExample() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.pdf"); 
      var format = DocumentFormat.Svg; 
      // We will create SVG files. This is not a multi-page format and the converter will 
      // create the files in the output directory ... 
      var outDir = Path.Combine(ImagesPath.Path, @"output"); 
      // Using the page numbering template. Change to to output page1.svg, page2.svg, etc. 
      documentConverter.Options.PageNumberingTemplate = "page(##page##).##extension##"; 
      var outFile = Path.Combine(outDir, "file.svg"); 
      var jobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format); 
 
      var job = documentConverter.Jobs.CreateJob(jobData); 
      documentConverter.Jobs.RunJob(job); 
 
      if (job.Status == DocumentConverterJobStatus.Success) 
      { 
         Console.WriteLine("Success"); 
 
         // Show the output files, these should be page1.svg, page2.svg, etc all in outDir 
         Console.WriteLine("All files generated:"); 
         foreach (var file in job.OutputFiles) 
            Console.WriteLine(file); 
 
         Console.WriteLine("Document files generated:"); 
         foreach (var file in job.OutputDocumentFiles) 
            Console.WriteLine(file); 
 
         Console.WriteLine("Extra document files generated:"); 
         foreach (var file in job.OutputDocumentExtraFiles) 
            Console.WriteLine(file); 
 
         Console.WriteLine("Annotation files generated:"); 
         foreach (var file in job.OutputAnnotationFiles) 
            Console.WriteLine(file); 
      } 
      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); 
         } 
      } 
   } 
}

 
import static org.junit.Assert.assertTrue; 
 
import java.io.File; 
import java.io.FileOutputStream; 
import java.io.IOException; 
import java.net.URI; 
import java.util.concurrent.Executors; 
import java.util.logging.ConsoleHandler; 
import java.util.logging.Handler; 
import java.util.logging.Level; 
import java.util.logging.Logger; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
 
import leadtools.*; 
import leadtools.annotations.rendering.AnnJavaRenderingEngine; 
import leadtools.caching.FileCache; 
import leadtools.codecs.*; 
import leadtools.document.DocumentFactory; 
import leadtools.document.DownloadDocumentOptions; 
import leadtools.document.LEADDocument; 
import leadtools.document.LoadDocumentOptions; 
import leadtools.document.LoadFromCacheOptions; 
import leadtools.document.UploadDocumentOptions; 
import leadtools.document.converter.DocumentConverter; 
import leadtools.document.converter.DocumentConverterEmptyPageMode; 
import leadtools.document.converter.DocumentConverterJob; 
import leadtools.document.converter.DocumentConverterJobData; 
import leadtools.document.converter.DocumentConverterJobError; 
import leadtools.document.converter.DocumentConverterJobErrorMode; 
import leadtools.document.converter.DocumentConverterJobStatus; 
import leadtools.document.converter.DocumentConverterJobs; 
import leadtools.document.writer.DocumentFormat; 
import leadtools.document.writer.DocumentWriter; 
import leadtools.ocr.OcrEngine; 
import leadtools.ocr.OcrEngineManager; 
import leadtools.ocr.OcrEngineType; 
 
 
public void documentConverterOutputFilesExample() { 
   String LEAD_VARS_ImagesDir = "C:\\LEADTOOLS23\\Resources\\Images"; 
   DocumentConverter documentConverter = new DocumentConverter(); 
   RasterDefaults.setExecutorService(Executors.newFixedThreadPool(5)); 
   documentConverter.getDiagnostics().setEnableTrace(true); 
   String inFile = combine(LEAD_VARS_ImagesDir, "Leadtools.pdf"); 
   DocumentFormat format = DocumentFormat.SVG; 
   // We will create SVG files. This is not a multi-page format and the converter will create the files in the output directory ... 
   String outFile = combine(LEAD_VARS_ImagesDir, "output.svg"); 
   // Using the page numbering template. Change to to output page1.svg, page2.svg, etc. 
   documentConverter.getOptions().setPageNumberingTemplate("page(##page##).##extension##"); 
 
   DocumentConverterJobData jobData = DocumentConverterJobs.createJobData(inFile, outFile, format); 
 
   DocumentConverterJob job = documentConverter.getJobs().createJob(jobData); 
   documentConverter.getJobs().runJob(job); 
   assertTrue(job.getStatus() == DocumentConverterJobStatus.SUCCESS); 
   if (job.getStatus() == DocumentConverterJobStatus.SUCCESS) { 
      System.out.println("Success!"); 
 
      System.out.println("All file generated: "); 
      for (String file : job.getOutputFiles()) 
         System.out.println(file); 
 
      System.out.println("Document files generated: "); 
      for (String file : job.getOutputDocumentFiles()) 
         System.out.println(file); 
 
      System.out.println("Extra document files generated: "); 
      for (String file : job.getOutputDocumentExtraFiles()) 
         System.out.println(file); 
 
      System.out.println("Annotation files generated: "); 
      for (String file : job.getOutputAnnotationFiles()) 
         System.out.println(file); 
   } else { 
      for (DocumentConverterJobError error : job.getErrors()) { 
         System.out.println(error.getError().toString()); 
      } 
   } 
}

Requirements

Target Platforms

Reference

DocumentConverterJob Class

DocumentConverterJob Members

Leadtools.Document.Converter Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies