Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OdfConversionReport

Namespace OfficeIMO.OpenDocument
Assembly OfficeIMO.OpenDocument
Source revision 804a7612eee4 with working tree changes
Implements
IOfficeConversionReport
Modifiers sealed

Feature mapping report for one explicit conversion between OpenDocument and another Office format.

Inheritance

  • Object
  • OdfConversionReport

Usage

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

Accepted by parameters 4

Constructors

public OdfConversionReport(String sourceFormat, String targetFormat) #

Creates an empty conversion report.

Parameters

sourceFormat System.String requiredposition: 0
targetFormat System.String requiredposition: 1

Methods

public OdfConversionReport Add(String feature, OdfConversionMappingStatus status, Int32 count = 1, String? message = null) #
Returns: OdfConversionReport

Adds one feature-level result and returns this report.

Parameters

feature System.String requiredposition: 0
status OfficeIMO.OpenDocument.OdfConversionMappingStatus requiredposition: 1
count System.Int32 = 1 optionalposition: 2
message System.String? = null optionalposition: 3
public Void ApplyPolicy(OdfConversionLossPolicy policy) #
Returns: Void

Applies an explicit conversion loss policy.

Parameters

policy OfficeIMO.OpenDocument.OdfConversionLossPolicy requiredposition: 0
public IReadOnlyList<OdfConversionMapping> ForFeature(String feature) #
Returns: IReadOnlyList<OdfConversionMapping>

Returns all results for one stable feature identifier.

Parameters

feature System.String requiredposition: 0
public Void RequireNoLoss() #
Returns: Void

Throws when any feature was approximated, skipped, or unsupported.

public Void RequireNoSkippedOrUnsupported() #
Returns: Void

Throws when any feature was skipped or unsupported; approximations are accepted.

Properties

public String SourceFormat { get; } #

Source format identifier.

public String TargetFormat { get; } #

Target format identifier.

public IReadOnlyList<OdfConversionMapping> Mappings { get; } #

Feature results in the order reported by the adapter.

public IReadOnlyList<OfficeConversionFidelityDiagnostic> FidelityDiagnostics { get; } #

Category-preserving diagnostics for downstream acceptance policies.

public Boolean HasLoss { get; } #

True when at least one feature was approximated, skipped, or unsupported.

public Boolean HasSkippedOrUnsupported { get; } #

True when at least one feature was skipped or unsupported.