PdfConversionReport Class

Contains information a PDF file conversion process.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public class PdfConversionReport

VB.NET

Public Class PdfConversionReport

Related API Members

The following members return PdfConversionReport objects:

• PdfDocumentConverter.ConversionReport

Remarks

Use the PdfDocumentConverter.ConversionReport property to obtain a PdfConversionReport object.

You can use the following properties to check whether conversion was successful:

PdfConversionReport.ConversionStatus

Gets the conversion status of the resulting PDF document.

PdfConversionReport.Issues

Gets the collection of issues occurred during PDF document conversion.

The following code snippet converts the “PdfAConversionDemo.pdf” file to PdfA2b format and displays the conversion status and issues in the console:

C#

using DevExpress.Pdf;
// ...
// Obtain a file to convert.
var filePath = "PdfAConversionDemo.pdf";
var converter = new PdfDocumentConverter(filePath);
// Convert the file to the specified format.
converter.Convert(PdfCompatibility.PdfA2b);
converter.SaveDocument("PdfAConversionDemoResult.pdf");

// Specify and display a conversion report.
var status = converter.ConversionReport.ConversionStatus;
Console.WriteLine($"Status: {status}");
Console.WriteLine("Issues:");
var issues = converter.ConversionReport.Issues;
foreach (var issue in issues){
    Console.WriteLine($"{issue.Severity}: {issue.Message}");
}

VB.NET

Imports DevExpress.Pdf
' ...
' Obtain a file to convert.
Private filePath = "PdfAConversionDemo.pdf"
Private converter = New PdfDocumentConverter(filePath)
' Convert the file to the specified format.
converter.Convert(PdfCompatibility.PdfA2b)
converter.SaveDocument("PdfAConversionDemoResult.pdf")

' Specify and display a conversion report.
Dim status = converter.ConversionReport.ConversionStatus
Console.WriteLine($"Status: {status}")
Console.WriteLine("Issues:")
Dim issues = converter.ConversionReport.Issues
For Each issue In issues
    Console.WriteLine($"{issue.Severity}: {issue.Message}")
Next issue

The image below displays the conversion report.

Inheritance

Object

PdfConversionReport