OfficeConversionReport
OfficeIMO
The common record of a completed conversion or format stage. Format-owned reports derive from it and add their typed evidence. Conversion failures throw rather than return a failed report.
Inheritance
- object
- OfficeConversionReport
Derived Types
Usage
Explore 6 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 2
- Property OfficeConversionException.Report
- Property OfficeConversionResult<T>.Report
Accepted by parameters 4
Constructors
public OfficeConversionReport(string source, string target, string? outputPath = null, long itemsWritten = 0, TimeSpan elapsed = default, IEnumerable<OfficeDiagnostic>? diagnostics = null) #Creates a report, taking a defensive snapshot of all diagnostics.
Parameters
- source string
- Source path, format, or in-memory source description.
- target string
- Target path, format, or in-memory target description.
- outputPath string? = null
- Written file path, or null for an in-memory or stream conversion.
- itemsWritten long = 0
- Number of pages or logical items written, as defined by the converter.
- elapsed System.TimeSpan = default
- Elapsed conversion time.
- diagnostics System.Collections.Generic.IEnumerable<OfficeIMO.OfficeDiagnostic>? = null
- Completed-stage diagnostics, or null for none.
Methods
public void ThrowIfLoss() #Throws an OfficeConversionException carrying this report if any fidelity loss is reported.
Inherited Methods
Properties
public string Source { get; } #Gets the source path, format or description.
public string Target { get; } #Gets the target path, format or description.
public string? OutputPath { get; } #Gets the written path, or null for a stream or in-memory result.
public long ItemsWritten { get; } #Gets pages or logical items written, as defined by the converter.
public IReadOnlyList<OfficeDiagnostic> Diagnostics { get; } #Gets the common diagnostics. Format-owned reports keep their typed findings in their own members.
public virtual bool HasLoss { get; } #Gets whether the report describes an approximation, omission, failure or unassessed content.