Class

WordImageExportExtensions

OfficeIMO.Word

Namespace: OfficeIMO.Word
Assembly: OfficeIMO.Word.Pdf
Source revision: e163ccb36643 with working tree changes
Source: WordDocument.Imaging.Conversion.cs:12
Modifiers: static

Renders Word pages through the PDF layout adapter.

Inheritance

object
WordImageExportExtensions

Methods

public static WordDocumentVisualInfo CreateVisualSnapshot(WordDocument document, WordImageExportOptions? options = null) #

WordDocument.Imaging.cs:15

Creates a format-neutral visual snapshot for the requested document page.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.WordImageExportOptions? = null optional

Returns

WordDocumentVisualInfo

CreateVisualSnapshots 2 overloads

public static IReadOnlyList<WordDocumentVisualInfo> CreateVisualSnapshots(WordDocument document, WordImageExportOptions? options = null)

WordDocument.Imaging.cs:24

Creates format-neutral visual snapshots for a page range or the complete document.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.WordImageExportOptions? = null optional

Returns

IReadOnlyList<WordDocumentVisualInfo>

public static IReadOnlyList<WordDocumentVisualInfo> CreateVisualSnapshots(WordDocument document, WordImageExportOptions? options, CancellationToken cancellationToken)

WordDocument.Imaging.cs:35

Creates format-neutral visual snapshots for a page range or the complete document with cooperative cancellation during pagination.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.WordImageExportOptions? required
cancellationToken System.Threading.CancellationToken required

Returns

IReadOnlyList<WordDocumentVisualInfo>

public static OfficeImageExportResult ExportImage(WordDocument document, OfficeImageExportFormat format, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

WordDocument.Imaging.cs:46

Exports the requested document page as a supported raster format or SVG.

Parameters

document OfficeIMO.Word.WordDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult

ExportImages 2 overloads

public static IReadOnlyList<OfficeImageExportResult> ExportImages(WordDocument document, OfficeImageExportFormat format, WordImageExportOptions? options = null)

WordDocument.Imaging.cs:53

Exports a page range or the complete document as PNG or SVG images.

Parameters

document OfficeIMO.Word.WordDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Word.WordImageExportOptions? = null optional

Returns

IReadOnlyList<OfficeImageExportResult>

public static void ExportImages(WordDocument document, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

WordDocument.Imaging.cs:63

Streams selected page images to a consumer without retaining earlier payloads.

Parameters

document OfficeIMO.Word.WordDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
consumer OfficeIMO.Drawing.OfficeImageExportConsumer required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

public static int GetEstimatedImagePageCount(WordDocument document) #

WordDocument.Imaging.cs:73

Returns how many pages the shared Word layout produces for this document.

Parameters

document OfficeIMO.Word.WordDocument required

Returns

int

public static int GetEstimatedPageCount(WordDocument document) #

WordDocument.Imaging.cs:20

Returns the shared layout's document page count.

Parameters

document OfficeIMO.Word.WordDocument required

Returns

int

SaveAsImage 2 overloads

public static OfficeConversionReport SaveAsImage(WordDocument document, string path, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

WordDocument.Imaging.Conversion.cs:39

Writes the selected page to a file and returns its fidelity report.

Parameters

document OfficeIMO.Word.WordDocument required
path string required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport

public static OfficeConversionReport SaveAsImage(WordDocument document, Stream stream, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

WordDocument.Imaging.Conversion.cs:49

Writes the selected page to a caller-owned stream and returns its fidelity report.

Parameters

document OfficeIMO.Word.WordDocument required
stream System.IO.Stream required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport

SaveAsImageAsync 2 overloads

public static async Task<OfficeConversionReport> SaveAsImageAsync(WordDocument document, string path, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously writes the selected page to a file and returns its fidelity report.

Parameters

document OfficeIMO.Word.WordDocument required
path string required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>

public static async Task<OfficeConversionReport> SaveAsImageAsync(WordDocument document, Stream stream, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously writes the selected page to a caller-owned stream and returns its fidelity report.

Parameters

document OfficeIMO.Word.WordDocument required
stream System.IO.Stream required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>

public static OfficeConversionReport SaveAsImages(WordDocument document, string folderPath, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

WordDocument.Imaging.Conversion.cs:81

Saves the selected pages without retaining their encoded payloads, and returns an aggregate report.

Parameters

document OfficeIMO.Word.WordDocument required
folderPath string required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport

public static async Task<OfficeConversionReport> SaveAsImagesAsync(WordDocument document, string folderPath, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously saves the selected pages without retaining payloads, and returns an aggregate report.

Parameters

document OfficeIMO.Word.WordDocument required
folderPath string required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>

ToImage 2 overloads

public static byte[] ToImage(WordDocument document, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

WordDocument.Imaging.Conversion.cs:12

Renders the selected page using the encoding in OfficeImageExportOptions.Format.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

byte[]

public static byte[] ToImage(WordDocument document, WordImageExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)

WordDocument.Imaging.Conversion.cs:17

Renders the selected page and returns its immutable fidelity report.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.WordImageExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

byte[]

public static async Task<OfficeConversionResult<byte[]>> ToImageAsync(WordDocument document, WordImageExportOptions? options = null, CancellationToken cancellationToken = default)

Renders the selected page with cancellation and returns the bytes and fidelity report.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.WordImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<byte[]>>

Search OfficeIMO

WordImageExportExtensions

Inheritance

Methods

Inherited Methods