EnableTrace Property

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

Syntax

C#
Visual Basic
Objective-C
Java
C++

public bool EnableTrace {get; set;}

'Declaration

Public Property EnableTrace As Boolean

'Usage

Dim instance As DocumentConverterDiagnostics
Dim value As Boolean
 
instance.EnableTrace = value
 
value = instance.EnableTrace

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

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

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

For an example, refer to DocumentConverterDiagnostics.

Requirements

Target Platforms

Reference

DocumentConverterDiagnostics Class
DocumentConverterDiagnostics Members