Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Class

XpsDocumentImageConversionExtensions

OfficeIMO.Xps

Edit on GitHub
Namespace
OfficeIMO.Xps
Assembly
OfficeIMO.Xps
Source revision
0eef6a5756b9 with working tree changes
Source
XpsDocument.ImageConversion.cs:12
Modifiers
static

Renders XPS surfaces through the existing native projection and shared image policies.

Inheritance

  • object
  • XpsDocumentImageConversionExtensions

Methods

public static OfficeConversionReport SaveAsImages(XpsDocument document, string folderPath, OfficeImageExportOptions? options = null, CancellationToken cancellationToken = default) #
XpsDocument.ImageConversion.cs:27

Saves selected pages with atomic files, bounded output and fidelity acceptance.

Parameters

document OfficeIMO.Xps.XpsDocument required
folderPath string required
options OfficeIMO.Drawing.OfficeImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Saves selected pages asynchronously without retaining completed image payloads.

Parameters

document OfficeIMO.Xps.XpsDocument required
folderPath string required
options OfficeIMO.Drawing.OfficeImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> ToImages(XpsDocument document, OfficeImageExportOptions? options = null, CancellationToken cancellationToken = default) #
XpsDocument.ImageConversion.cs:12

Renders selected source pages in caller order, retaining source and encoding diagnostics.

Parameters

document OfficeIMO.Xps.XpsDocument required
options OfficeIMO.Drawing.OfficeImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static void ToImages(XpsDocument document, OfficeImageExportConsumer consumer, OfficeImageExportOptions? options = null, CancellationToken cancellationToken = default) #
XpsDocument.ImageConversion.cs:17

Streams selected images without retaining earlier encoded payloads.

Parameters

document OfficeIMO.Xps.XpsDocument required
consumer OfficeIMO.Drawing.OfficeImageExportConsumer required
options OfficeIMO.Drawing.OfficeImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(XpsDocument document, OfficeImageExportOptions? options = null, CancellationToken cancellationToken = default) #
XpsDocument.ImageConversion.cs:22

Renders selected source pages asynchronously with shared cancellation and deadlines.

Parameters

document OfficeIMO.Xps.XpsDocument required
options OfficeIMO.Drawing.OfficeImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<IReadOnlyList<OfficeImageExportResult>>