Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeCompatibilityReport

Namespace OfficeIMO
Assembly OfficeIMO.Core
Modifiers sealed

Immutable feature-level fidelity report for one Office conversion assessment.

Inheritance

  • Object
  • OfficeCompatibilityReport

Constructors

public OfficeCompatibilityReport(OfficeFormatDescriptor sourceFormat, OfficeFormatDescriptor destinationFormat, OfficeCompatibilityMode mode, IEnumerable<OfficeCompatibilityFinding> findings = null) #

Creates a compatibility report.

Parameters

sourceFormat OfficeIMO.OfficeFormatDescriptor requiredposition: 0
destinationFormat OfficeIMO.OfficeFormatDescriptor requiredposition: 1
mode OfficeIMO.OfficeCompatibilityMode requiredposition: 2
findings System.Collections.Generic.IEnumerable{OfficeIMO.OfficeCompatibilityFinding} = null optionalposition: 3

Methods

public IReadOnlyList<OfficeCompatibilityFinding> GetFindings(OfficeCompatibilityImpact impact) #
Returns: IReadOnlyList<OfficeCompatibilityFinding>

Returns findings affecting a requested fidelity dimension.

Parameters

impact OfficeIMO.OfficeCompatibilityImpact requiredposition: 0
public virtual Void RequireNoLoss() #
Returns: Void

Throws when the report contains loss or a blocked feature.

Properties

public OfficeFormatDescriptor SourceFormat { get; } #

Gets the detected source format.

public OfficeFormatDescriptor DestinationFormat { get; } #

Gets the requested destination format.

public OfficeCompatibilityMode Mode { get; } #

Gets the requested compatibility policy.

public IReadOnlyList<OfficeCompatibilityFinding> Findings { get; } #

Gets all feature-level decisions in discovery order.

public virtual IReadOnlyList<OfficeConversionFidelityDiagnostic> FidelityDiagnostics { get; } #

Gets category-preserving compatibility diagnostics.

public virtual Boolean HasLoss { get; } #

Gets whether any finding reports approximation, omission, or failure.

public Boolean HasBlockedFeatures { get; } #

Gets whether any feature blocks artifact creation.

public Boolean HasSecurityImpact { get; } #

Gets whether active content or another security property changes.

public Boolean IsStrictlyCompatible { get; } #

Gets whether every reported feature remains native or semantically equivalent.