API Reference
PdfConversionReport
Collects shared PDF conversion warnings from one adapter run.
Inheritance
- Object
- PdfConversionReport
Usage
Explore 11 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 7
- Property PdfBytesResult.Report
- Method PdfConversionReport.RequireNoErrorWarnings
- Method PdfConversionReport.RequireNoLoss
- Method PdfConversionReport.RequireNoWarnings
- Method PdfConversionReport.Snapshot
- Property PdfDocumentConversionResult.Report
- Property PdfSaveResult.Report
Accepted by parameters 4
Constructors
public PdfConversionReport() #Creates an empty mutable report for one in-progress converter operation.
Methods
public Void Add(PdfConversionWarning warning) #VoidAdds one warning to the report.
Parameters
- warning OfficeIMO.Pdf.PdfConversionWarning
public Void AddFontDiagnostics(IEnumerable<PdfFontEmbeddingDiagnostic> diagnostics, String converter = "OfficeIMO.Pdf") #VoidAdds shared embedded-font diagnostics as conversion warnings.
Parameters
- diagnostics System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfFontEmbeddingDiagnostic>
- converter System.String = "OfficeIMO.Pdf"
public Void AddRange(IEnumerable<PdfConversionWarning> warnings) #VoidAdds all warnings from another report.
Parameters
- warnings System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfConversionWarning>
public Void AddTextDiagnostics(IEnumerable<PdfTextEncodingDiagnostic> diagnostics, String converter = "OfficeIMO.Pdf") #VoidAdds shared text encoding diagnostics as conversion warnings.
Parameters
- diagnostics System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfTextEncodingDiagnostic>
- converter System.String = "OfficeIMO.Pdf"
public Void AddTextFallbackPlanDiagnostics(PdfTextFallbackPlan plan, String converter = "OfficeIMO.Pdf") #VoidAdds missing-glyph diagnostics from an embedded-font fallback plan as conversion warnings.
Parameters
- plan OfficeIMO.Pdf.PdfTextFallbackPlan
- converter System.String = "OfficeIMO.Pdf"
public Void AddTextShapingDiagnostics(IEnumerable<PdfTextShapingDiagnostic> diagnostics, String converter = "OfficeIMO.Pdf") #VoidAdds shared text shaping diagnostics as conversion warnings.
Parameters
- diagnostics System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfTextShapingDiagnostic>
- converter System.String = "OfficeIMO.Pdf"
public PdfConversionReport RequireNoErrorWarnings() #PdfConversionReportThrows when the report contains error-severity conversion warnings; otherwise returns the current report for fluent checks.
public PdfConversionReport RequireNoLoss() #PdfConversionReportThrows when conversion reported an approximation, omission, failure, or unassessed fidelity. Informational diagnostics with no fidelity loss are allowed.
public PdfConversionReport RequireNoWarnings() #PdfConversionReportThrows when the report contains any conversion warning; otherwise returns the current report for fluent checks.
public PdfConversionReport Snapshot() #PdfConversionReportCreates an independent, read-only snapshot of all warnings currently visible through this report.
public PdfConversionReportSummary Summarize() #PdfConversionReportSummaryBuilds a stable count summary for proof packs, logs, wrapper routing, and user-facing diagnostics.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Boolean IsReadOnly { get; } #True when this report is a frozen result snapshot and can no longer be modified.
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, failure, or unassessed fidelity.
public IReadOnlyList<OfficeConversionFidelityDiagnostic> FidelityDiagnostics { get; } #Gets category-preserving diagnostics for composed conversion routes.
public PdfConversionFidelityStatus FidelityStatus { get; } #High-level fidelity outcome derived from the structured warnings. Declared font-family and bounded typography substitutions are distinguished from other lossy or unsupported behavior.