API Reference
Class
OfficeOutputResult`1
Pairs output status with the typed fidelity evidence from a document conversion.
Inheritance
- Object
- OfficeOutputResult`1
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
Type Parameters
- TReport
- Format-specific conversion report.
Methods
public static OfficeOutputResult<TReport> FromFailure(String outputPath, Exception exception, TReport report = null) #Returns:
OfficeOutputResult<TReport>Creates a failed output result, preserving any report completed before the failure.
Parameters
- outputPath System.String
- exception System.Exception
- report `0 = null
public static OfficeOutputResult<TReport> FromSuccess(String outputPath, TReport report) #Returns:
OfficeOutputResult<TReport>Creates a successful output result after the native writer has completed.
Parameters
- outputPath System.String
- report `0
public OfficeOutputResult<TReport> RequireNoLoss() #Returns:
OfficeOutputResult<TReport>Requires successful output and conversion evidence without reported loss.
public OfficeOutputResult<TReport> RequireSuccess() #Returns:
OfficeOutputResult<TReport>Returns this result after verifying that an artifact was written successfully.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public virtual Boolean Succeeded { get; } #public virtual String OutputPath { get; } #public virtual Exception Exception { get; } #public TReport Report { get; } #Conversion evidence produced before writing, when available.
public Boolean HasLoss { get; } #Whether available conversion evidence reports possible content loss.