Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 578 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 revision 45ddf07f0b84 with working tree changes
Source EpubImageExportExtensions.cs:42
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) #
EpubImageExportExtensions.cs:42
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) #
EpubImageExportExtensions.cs:58
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 EpubFixedLayoutInspection InspectFixedLayoutPage(EpubDocument source, Int32 chapterIndex, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EpubImageExportExtensions.Inspection.cs:22
Returns: EpubFixedLayoutInspection

Renders one retained fixed-layout XHTML chapter using its declared numeric viewport and checks rendered element rectangles against that canvas. Uses the shared HTML/Drawing engines and package resource resolver. No image is encoded. Rectangular scene clipping is reported separately. XHTML and embedded vector text ink use separate bounded contour and supported-clip checks. SVG spine inspection, individual region overflow and native-reader equivalence are not established by this check.

Parameters

source OfficeIMO.Epub.EpubDocument requiredposition: 0
Publication loaded with raw HTML and resource payloads retained.
chapterIndex System.Int32 requiredposition: 1
Zero-based chapter index.
options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optionalposition: 2
Font, resource and safety settings. Mode, viewport and margins are set from the page; chapter selection and image-output settings do not apply. External asynchronous resources remain diagnosed.
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
Cooperative cancellation.
public static EpubFixedLayoutInspection InspectFixedLayoutRegions(EpubDocument source, Int32 chapterIndex, IReadOnlyList<String> regionElementIds, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EpubImageExportExtensions.Inspection.cs:36
Returns: EpubFixedLayoutInspection

Inspects the page canvas and selected identified positioned, floating, flex or grid regions in one render pass. Region findings use local border-box coordinates, before the region's own and ancestor transforms. Descendant transforms and authored clips are retained. Ancestor clips do not redefine local containment. Positioned XHTML and vector text ink is reported separately, including rectangular and filled path clipping; unsupported paths remain unmeasured. Missing, duplicate, hidden or unsupported region targets fail explicitly.

Parameters

source OfficeIMO.Epub.EpubDocument requiredposition: 0
Publication loaded with raw HTML and resource payloads retained.
chapterIndex System.Int32 requiredposition: 1
Zero-based fixed-layout XHTML chapter index.
regionElementIds System.Collections.Generic.IReadOnlyList<System.String> requiredposition: 2
One to 1024 distinct HTML element IDs to inspect.
options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optionalposition: 3
Font, resource and safety settings, as for page inspection.
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
Cooperative cancellation.
public static EpubImageExportBuilder ToImages(EpubDocument source, EpubImageExportOptions? options = null) #
EpubImageExportExtensions.cs:150
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