Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 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/

API Reference

Class

EpubImageExportExtensions

Edit on GitHub
Namespace OfficeIMO.Epub.Image
Assembly OfficeIMO.Epub.Image
Source ../../../../_/OfficeIMO.Epub.Image/EpubImageExportExtensions.cs:36
Modifiers static

EPUB image-export entry points backed by OfficeIMO.Html.

Inheritance

  • Object
  • EpubImageExportExtensions

Methods

ExportImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(EpubDocument source, OfficeImageExportFormat format, EpubImageExportOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Epub.Image/EpubImageExportExtensions.cs:36
Returns: IReadOnlyList<OfficeImageExportResult>

Exports selected EPUB chapters through the shared image result contract.

Parameters

source OfficeIMO.Epub.EpubDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Epub.Image.EpubImageExportOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static Void ExportImages(EpubDocument source, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, EpubImageExportOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Epub.Image/EpubImageExportExtensions.cs:52
Returns: Void

Streams selected EPUB chapter images without retaining earlier payloads.

Parameters

source OfficeIMO.Epub.EpubDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportConsumer requiredposition: 2
options OfficeIMO.Epub.Image.EpubImageExportOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
ExportImagesAsync 2 overloads
public static async Task<IReadOnlyList<OfficeImageExportResult>> ExportImagesAsync(EpubDocument source, OfficeImageExportFormat format, EpubImageExportOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Asynchronously exports selected EPUB chapters and resolves retained package resources.

Parameters

source OfficeIMO.Epub.EpubDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Epub.Image.EpubImageExportOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static async Task ExportImagesAsync(EpubDocument source, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, EpubImageExportOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task

Asynchronously streams selected EPUB chapter images.

Parameters

source OfficeIMO.Epub.EpubDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer requiredposition: 2
options OfficeIMO.Epub.Image.EpubImageExportOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
public static EpubImageExportBuilder ToImages(EpubDocument source, EpubImageExportOptions options = null) #
../../../../_/OfficeIMO.Epub.Image/EpubImageExportExtensions.cs:142
Returns: EpubImageExportBuilder

Starts fluent image export for selected EPUB chapters.

Parameters

source OfficeIMO.Epub.EpubDocument requiredposition: 0
options OfficeIMO.Epub.Image.EpubImageExportOptions = null optionalposition: 1