API Reference

Class

PdfConversionReport

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Collects shared PDF conversion warnings from one adapter run.

Inheritance

  • Object
  • PdfConversionReport

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

Methods

public Void Add(PdfConversionWarning warning) #
Returns: Void

Adds one warning to the report.

Parameters

warning OfficeIMO.Pdf.PdfConversionWarning requiredposition: 0
public Void AddFontDiagnostics(IEnumerable<PdfFontEmbeddingDiagnostic> diagnostics, String converter = "OfficeIMO.Pdf") #
Returns: Void

Adds shared embedded-font diagnostics as conversion warnings.

Parameters

diagnostics System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfFontEmbeddingDiagnostic} requiredposition: 0
converter System.String = "OfficeIMO.Pdf" optionalposition: 1
public Void AddRange(IEnumerable<PdfConversionWarning> warnings) #
Returns: Void

Adds all warnings from another report.

Parameters

warnings System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfConversionWarning} requiredposition: 0
public Void AddTextDiagnostics(IEnumerable<PdfTextEncodingDiagnostic> diagnostics, String converter = "OfficeIMO.Pdf") #
Returns: Void

Adds shared text encoding diagnostics as conversion warnings.

Parameters

diagnostics System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTextEncodingDiagnostic} requiredposition: 0
converter System.String = "OfficeIMO.Pdf" optionalposition: 1
public Void AddTextFallbackPlanDiagnostics(PdfTextFallbackPlan plan, String converter = "OfficeIMO.Pdf") #
Returns: Void

Adds missing-glyph diagnostics from an embedded-font fallback plan as conversion warnings.

Parameters

plan OfficeIMO.Pdf.PdfTextFallbackPlan requiredposition: 0
converter System.String = "OfficeIMO.Pdf" optionalposition: 1
public Void AddTextShapingDiagnostics(IEnumerable<PdfTextShapingDiagnostic> diagnostics, String converter = "OfficeIMO.Pdf") #
Returns: Void

Adds shared text shaping diagnostics as conversion warnings.

Parameters

diagnostics System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTextShapingDiagnostic} requiredposition: 0
converter System.String = "OfficeIMO.Pdf" optionalposition: 1
public Void Clear() #
Returns: Void

Clears warnings from a previous conversion run.

public PdfConversionReport RequireNoErrorWarnings() #
Returns: PdfConversionReport

Throws when the report contains error-severity conversion warnings; otherwise returns the current report for fluent checks.

public PdfConversionReport RequireNoLoss() #
Returns: PdfConversionReport

Throws when conversion reported an approximation, omission, or error; informational diagnostics are allowed.

public PdfConversionReport RequireNoWarnings() #
Returns: PdfConversionReport

Throws when the report contains any conversion warning; otherwise returns the current report for fluent checks.

public PdfConversionReportSummary Summarize() #
Returns: PdfConversionReportSummary

Builds a stable count summary for proof packs, logs, wrapper routing, and user-facing diagnostics.

Properties

public IReadOnlyList<PdfConversionWarning> Warnings { get; } #

Warnings recorded by the converter in production order.

public Boolean HasWarnings { get; } #

True when at least one warning was recorded.

public Boolean HasErrors { get; } #

True when at least one error-severity warning was recorded.

public Boolean HasLoss { get; } #

True when conversion reported an approximation, omission, or error.