API Reference

Class

OdfConversionReport

Namespace OfficeIMO.OpenDocument
Assembly OfficeIMO.OpenDocument
Modifiers sealed

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

Inheritance

  • Object
  • OdfConversionReport

Usage

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

Returned or exposed by

Accepted by parameters

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

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 Boolean HasLoss { get; } #

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