Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeConversionResult`2

Namespace OfficeIMO
Assembly OfficeIMO.Core
Implements
IOfficeConversionResult<TValue, TReport> IOfficeResult<TValue> IOfficeResult

Common implementation for conversions that return a native value together with a typed fidelity report.

Inheritance

  • Object
  • OfficeConversionResult`2

Type Parameters

TValue
Native target document, text, artifact, or reference type.
TReport
Typed fidelity report produced by the conversion.

Constructors

public OfficeConversionResult<TValue, TReport>(TValue value, TReport report) #

Creates a conversion result.

Parameters

value TValue requiredposition: 0
report TReport requiredposition: 1

Methods

public virtual TValue RequireNoLoss() #
Returns: TValue

Returns the produced value only when conversion completed without reported loss.

public virtual TValue RequireValue() #
Returns: TValue

Returns the produced value or throws when the operation did not complete.

Properties

public TValue Value { get; } #

Gets the produced value, or null when the operation did not complete.

public TReport Report { get; } #

Gets the typed conversion report.

public virtual Boolean Succeeded { get; } #

Gets whether the operation completed successfully.

public virtual Boolean HasLoss { get; } #

Gets whether the conversion reported possible fidelity loss.