EnableTrace Property

Summary

Indicates whether this DocumentConverter should output debug messages to the standard .NET trace listeners.

Syntax

C++/CLI

Java

Python

public bool EnableTrace { get; set; }

public:  
   property bool EnableTrace 
   { 
      bool get() 
      void set(bool value) 
   }

public boolean getEnableTrace() 
public void setEnableTrace(boolean value)

EnableTrace # get and set (DocumentConverterDiagnostics)

Property Value

true if this DocumentConverter should output debug messages to the standard .NET trace listeners; otherwise, false Default value is false.

Remarks

If the value of this property is set to true, then this DocumentConverter object will output debug messages with current status (page being loaded, converted, saved, etc.) and any errors that may occur to the default .NET trace listener.

For example, to enable tracing to the .NET console, use the following code:

// Trace to the console 
System.Diagnostics.Trace.Listeners.Add(new TextWriterTraceListener(Console.Out)); 
// Enable tracing in the document converter 
documentConverter.Diagnostics.EnableTrace = true; 
// Run the job 
documentConverter.Jobs.RunJob(job);

When tracing is enabled, the engine will use the DocumentConverterJobData.JobName value when writing trace messages to help easily identity jobs.

For more information on .NET tracing and how to redirect the messages to a file, the system log or a database, refer to System.Diagnostics.Trace in MSDN.

Example

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 DocumentConverterDiagnosticsExample() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      //enables diagnostics print out 
      documentConverter.Diagnostics.EnableTrace = true; 
 
      //output traces to console's window 
      Trace.Listeners.Add(new TextWriterTraceListener(Console.Out)); 
 
      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); 
         } 
      } 
   } 
}

Requirements

Target Platforms

Reference

DocumentConverterDiagnostics Class

DocumentConverterDiagnostics Members

Leadtools.Document.Converter Namespace

Download our FREE evaluation

Help Version 22.0.2023.5.10

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies