OutputFiles Property

C#
Visual Basic
Objective-C
Java
C++

public IList<string> OutputFiles {get;}

'Declaration

Public ReadOnly Property OutputFiles As IList(Of String)

'Usage

Dim instance As DocumentConverterJob
Dim value As IList(Of String)
 
value = instance.OutputFiles

public List<String> getOutputFiles()

public:
property IList<String^>^ OutputFiles {
   IList<String^>^ get();
}

Property Value

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

This list contains one or more of the following:

If the output format supports multi-page 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).

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.Forms.DocumentWriters
Imports Leadtools.Svg
Imports Leadtools.Documents
Imports Leadtools.Caching
Imports Leadtools.Annotations.Core
Imports Leadtools.Forms.Ocr
Imports Leadtools.Documents.Converters

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 jobData As DocumentConverterJobData = DocumentConverterJobs.CreateJobData(inFile, outDir, 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

using Leadtools;
using Leadtools.Codecs;
using Leadtools.Forms.DocumentWriters;
using Leadtools.Svg;
using Leadtools.Documents;
using Leadtools.Caching;
using Leadtools.Annotations.Core;
using Leadtools.Forms.Ocr;
using Leadtools.Documents.Converters;

[TestMethod]
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 jobData = DocumentConverterJobs.CreateJobData(inFile, outDir, 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);
         }
      }
   }
}

Target Platforms

Reference

DocumentConverterJob Class
DocumentConverterJob Members