API Reference

Class

ReaderVisualExportMaterializer

Namespace OfficeIMO.Reader
Assembly OfficeIMO.Reader
Modifiers static

Helpers for writing or streaming visual export sidecars.

Inheritance

  • Object
  • ReaderVisualExportMaterializer

Methods

public static IReadOnlyList<ReaderVisualMaterializedExport> StreamVisualExports(IEnumerable<ReaderVisualExportBundle> exports, Action<ReaderVisualExportBundle, ReaderVisualExportFormat, Stream> writeExport, ReaderVisualExportMaterializationOptions options = null, CancellationToken cancellationToken = null) #
Returns: IReadOnlyList<ReaderVisualMaterializedExport>

Streams visual export sidecars to a caller-owned callback without writing files.

Parameters

exports System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderVisualExportBundle} requiredposition: 0
Visual export bundles.
writeExport System.Action{OfficeIMO.Reader.ReaderVisualExportBundle,OfficeIMO.Reader.ReaderVisualExportFormat,System.IO.Stream} requiredposition: 1
Callback that receives each export, format, and readable payload stream.
options OfficeIMO.Reader.ReaderVisualExportMaterializationOptions = null optionalposition: 2
Materialization options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
Cancellation token.
public static IReadOnlyList<ReaderVisualMaterializedExport> WriteVisualExportsToDirectory(IEnumerable<ReaderVisualExportBundle> exports, String directoryPath, ReaderVisualExportMaterializationOptions options = null, CancellationToken cancellationToken = null) #
Returns: IReadOnlyList<ReaderVisualMaterializedExport>

Writes visual export sidecars to directoryPath using each bundle's deterministic filename stem.

Parameters

exports System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderVisualExportBundle} requiredposition: 0
Visual export bundles.
directoryPath System.String requiredposition: 1
Destination directory.
options OfficeIMO.Reader.ReaderVisualExportMaterializationOptions = null optionalposition: 2
Materialization options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
Cancellation token.