Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 701 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

OdgDocumentImageConversionExtensions

OfficeIMO.OpenDocument

Edit on GitHub
Namespace
OfficeIMO.OpenDocument
Assembly
OfficeIMO.OpenDocument
Source revision
ac7e6e1bad8a with working tree changes
Source
OdgDocument.ImageConversion.cs:12
Modifiers
static

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

Inheritance

  • object
  • OdgDocumentImageConversionExtensions

Methods

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

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

Parameters

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

Returns

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

Saves selected pages asynchronously without retaining completed image payloads.

Parameters

document OfficeIMO.OpenDocument.OdgDocument 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(OdgDocument document, OfficeImageExportOptions? options = null, CancellationToken cancellationToken = default) #
OdgDocument.ImageConversion.cs:12

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

Parameters

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

Returns

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

Streams selected images without retaining earlier encoded payloads.

Parameters

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

Renders selected source pages asynchronously with shared cancellation and deadlines.

Parameters

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

Returns

Task<IReadOnlyList<OfficeImageExportResult>>