←Select platform

OutputFiles Property

Summary

Output files generated by this conversion job.

Syntax
C#
VB
Java
C++
public IList<string> OutputFiles { get; } 
Public ReadOnly Property OutputFiles() As System.Collections.Generic.IList(Of String) 
   Get 
public:  
   property System::Collections::Generic::IList<String^>^ OutputFiles 
   { 
      System::Collections::Generic::IList<String^>^ get() 
   } 
public List<String> getOutputFiles() 

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:

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
C#
VB
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 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); 
         } 
      } 
   } 
} 
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 DocumentConverterOutputFilesExample() 
   Using documentConverter As New DocumentConverter() 
      Dim inFile As String = Path.Combine(ImagesPath.Path, "Leadtools.pdf") 
      Dim format As DocumentFormat = 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 ... 
      Dim outDir As String = 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##" 
      Dim outFile As String = Path.Combine(outDir, "file.svg") 
      Dim jobData As DocumentConverterJobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format) 
 
      Dim job As DocumentConverterJob = documentConverter.Jobs.CreateJob(jobData) 
      documentConverter.Jobs.RunJob(job) 
 
      If job.Status = DocumentConverterJobStatus.Success Then 
         Console.WriteLine("Success") 
 
         ' Show the output files, these should be page1.svg, page2.svg, etc all in outDir 
         Console.WriteLine("All files generated:") 
         For Each file As String In job.OutputFiles 
            Console.WriteLine(file) 
         Next 
 
         Console.WriteLine("Document files generated:") 
         For Each file As String In job.OutputDocumentFiles 
            Console.WriteLine(file) 
         Next 
 
         Console.WriteLine("Extra document files generated:") 
         For Each file As String In job.OutputDocumentExtraFiles 
            Console.WriteLine(file) 
         Next 
 
         Console.WriteLine("Annotation files generated:") 
         For Each file As String In job.OutputAnnotationFiles 
            Console.WriteLine(file) 
         Next 
      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 

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Converter Assembly