API Reference

Class

OfficeDocumentAssetMaterializer

Namespace OfficeIMO.Reader
Assembly OfficeIMO.Reader
Modifiers static

Helpers for writing or streaming materializable assets from a shared read result.

Inheritance

  • Object
  • OfficeDocumentAssetMaterializer

Methods

public static IReadOnlyList<OfficeDocumentMaterializedAsset> StreamAssets(OfficeDocumentReadResult result, Action<OfficeDocumentAsset, Stream> writeAsset, OfficeDocumentAssetMaterializationOptions options = null, CancellationToken cancellationToken = null) #
Returns: IReadOnlyList<OfficeDocumentMaterializedAsset>

Streams materializable asset payloads to a caller-owned callback without writing files.

Parameters

result OfficeIMO.Reader.OfficeDocumentReadResult requiredposition: 0
Read result that owns the assets.
writeAsset System.Action{OfficeIMO.Reader.OfficeDocumentAsset,System.IO.Stream} requiredposition: 1
Callback that receives each asset and a readable payload stream.
options OfficeIMO.Reader.OfficeDocumentAssetMaterializationOptions = null optionalposition: 2
Materialization options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
Cancellation token.
public static IReadOnlyList<OfficeDocumentMaterializedAsset> WriteAssetsToDirectory(OfficeDocumentReadResult result, String directoryPath, OfficeDocumentAssetMaterializationOptions options = null, CancellationToken cancellationToken = null) #
Returns: IReadOnlyList<OfficeDocumentMaterializedAsset>

Writes materializable asset payloads to directoryPath using each asset's deterministic filename.

Parameters

result OfficeIMO.Reader.OfficeDocumentReadResult requiredposition: 0
Read result that owns the assets.
directoryPath System.String requiredposition: 1
Destination directory.
options OfficeIMO.Reader.OfficeDocumentAssetMaterializationOptions = null optionalposition: 2
Materialization options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
Cancellation token.