Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordOpenDocumentImageExportExtensions

OfficeIMO.Word.OpenDocument

Namespace
OfficeIMO.Word.OpenDocument
Assembly
OfficeIMO.Word.OpenDocument
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Thin ODT image-export bridge over the Word visual renderer.

Inheritance

  • object
  • WordOpenDocumentImageExportExtensions

Methods

public static OfficeConversionReport SaveAsImages(OdtDocument document, string folderPath, WordImageExportOptions? imageOptions = null, WordOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Saves selected source surfaces through the shared atomic file and fidelity policies.

Parameters

document OfficeIMO.OpenDocument.OdtDocument required
folderPath string required
imageOptions OfficeIMO.Word.WordImageExportOptions? = null optional
conversionOptions OfficeIMO.Word.OpenDocument.WordOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static async Task<OfficeConversionReport> SaveAsImagesAsync(OdtDocument document, string folderPath, WordImageExportOptions? imageOptions = null, WordOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Saves selected source surfaces asynchronously without retaining earlier encoded payloads.

Parameters

document OfficeIMO.OpenDocument.OdtDocument required
folderPath string required
imageOptions OfficeIMO.Word.WordImageExportOptions? = null optional
conversionOptions OfficeIMO.Word.OpenDocument.WordOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static OfficeImageExportResult ToImage(OdtDocument source, OfficeImageExportFormat format, WordImageExportOptions? imageOptions = null, WordOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Converts an ODT document to Word semantics and exports one selected page.

Parameters

source OfficeIMO.OpenDocument.OdtDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
imageOptions OfficeIMO.Word.WordImageExportOptions? = null optional
conversionOptions OfficeIMO.Word.OpenDocument.WordOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult
ToImages 3 overloads
public static IReadOnlyList<OfficeImageExportResult> ToImages(OdtDocument document, WordImageExportOptions? imageOptions = null, WordOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Renders selected source surfaces using the encoding in the image options.

Parameters

document OfficeIMO.OpenDocument.OdtDocument required
imageOptions OfficeIMO.Word.WordImageExportOptions? = null optional
conversionOptions OfficeIMO.Word.OpenDocument.WordOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static IReadOnlyList<OfficeImageExportResult> ToImages(OdtDocument source, OfficeImageExportFormat format, WordImageExportOptions? imageOptions = null, WordOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Converts an ODT document to Word semantics and exports selected estimated pages.

Parameters

source OfficeIMO.OpenDocument.OdtDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
imageOptions OfficeIMO.Word.WordImageExportOptions? = null optional
conversionOptions OfficeIMO.Word.OpenDocument.WordOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static void ToImages(OdtDocument source, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, WordImageExportOptions? imageOptions = null, WordOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Streams selected ODT page images without retaining earlier payloads.

Parameters

source OfficeIMO.OpenDocument.OdtDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
consumer OfficeIMO.Drawing.OfficeImageExportConsumer required
imageOptions OfficeIMO.Word.WordImageExportOptions? = null optional
conversionOptions OfficeIMO.Word.OpenDocument.WordOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(OdtDocument document, WordImageExportOptions? imageOptions = null, WordOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Renders selected source surfaces asynchronously under one shared operation deadline and budget.

Parameters

document OfficeIMO.OpenDocument.OdtDocument required
imageOptions OfficeIMO.Word.WordImageExportOptions? = null optional
conversionOptions OfficeIMO.Word.OpenDocument.WordOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<IReadOnlyList<OfficeImageExportResult>>