Back to Devexpress

PdfDocumentConverter.ConversionReport Property

officefileapi-devexpress-dot-pdf-dot-pdfdocumentconverter.md

latest2.9 KB
Original Source

PdfDocumentConverter.ConversionReport Property

Gets the report with the conversion status of the resulting PDF document.

Namespace : DevExpress.Pdf

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public PdfConversionReport ConversionReport { get; }
vb
Public ReadOnly Property ConversionReport As PdfConversionReport

Property Value

TypeDescription
PdfConversionReport

The report with the conversion status of the resulting PDF document.

|

Remarks

ConversionReport provides access to the PdfConversionReport object and its settings.

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

csharp
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
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.

See Also

PdfDocumentConverter Class

PdfDocumentConverter Members

DevExpress.Pdf Namespace