# EpubImageExportExtensions

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

Class 

`OfficeIMO.Epub.Image`

**Namespace**

`OfficeIMO.Epub.Image`

**Assembly**

`OfficeIMO.Epub.Image`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[EpubImageExportExtensions.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportExtensions.cs#L43)

**Modifiers**

static

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

## Inheritance

- object
- EpubImageExportExtensions

Filter members 

Show inherited

## Methods

`public static EpubFixedLayoutInspection InspectFixedLayoutPage(EpubDocument source, int chapterIndex, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-inspectfixedlayoutpage-officeimo-epub-epubdocument-int32-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken)

[EpubImageExportExtensions.Inspection.cs:22](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportExtensions.Inspection.cs#L22)

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 required**

Publication loaded with raw HTML and resource payloads retained.

**chapterIndex int required**

Zero-based chapter index.

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

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 optional**

Cooperative cancellation.

Returns

`EpubFixedLayoutInspection`

`public static EpubFixedLayoutInspection InspectFixedLayoutRegions(EpubDocument source, int chapterIndex, IReadOnlyList<string> regionElementIds, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-inspectfixedlayoutregions-officeimo-epub-epubdocument-int32-collections-generic-ireadonlylist-system-string-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken)

[EpubImageExportExtensions.Inspection.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportExtensions.Inspection.cs#L36)

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 required**

Publication loaded with raw HTML and resource payloads retained.

**chapterIndex int required**

Zero-based fixed-layout XHTML chapter index.

**regionElementIds System.Collections.Generic.IReadOnlyList<string> required**

One to 1024 distinct HTML element IDs to inspect.

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

Font, resource and safety settings, as for page inspection.

**cancellationToken System.Threading.CancellationToken = default optional**

Cooperative cancellation.

Returns

`EpubFixedLayoutInspection`

`public static OfficeConversionReport SaveAsImages(EpubDocument document, string folderPath, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasimages-officeimo-epub-epubdocument-string-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken)

[EpubDocument.ImageBatchConversion.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubDocument.ImageBatchConversion.cs#L24)

Saves selected images without retaining payloads and returns aggregate conversion evidence.

Parameters

**document OfficeIMO.Epub.EpubDocument required**

**folderPath string required**

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

`public static async Task<OfficeConversionReport> SaveAsImagesAsync(EpubDocument document, string folderPath, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasimagesasync-officeimo-epub-epubdocument-string-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken)

Asynchronously saves selected images, retaining paths and evidence rather than encoded payloads.

Parameters

**document OfficeIMO.Epub.EpubDocument required**

**folderPath string required**

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

ToImages 3 overloads

`public static IReadOnlyList<OfficeImageExportResult> ToImages(EpubDocument document, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toimages-officeimo-epub-epubdocument-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken)

[EpubDocument.ImageBatchConversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubDocument.ImageBatchConversion.cs#L10)

Renders a batch using the encoding and selection in the options.

Parameters

**document OfficeIMO.Epub.EpubDocument required**

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`IReadOnlyList<OfficeImageExportResult>`

`public static IReadOnlyList<OfficeImageExportResult> ToImages(EpubDocument source, OfficeImageExportFormat format, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toimages-officeimo-epub-epubdocument-officeimo-drawing-officeimageexportformat-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken)

[EpubImageExportExtensions.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportExtensions.cs#L43)

Exports selected EPUB chapters through the shared image result contract.

Parameters

**source OfficeIMO.Epub.EpubDocument required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`IReadOnlyList<OfficeImageExportResult>`

`public static void ToImages(EpubDocument source, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#member-faa504b9e1c2e82bdf7b61c8)

[EpubImageExportExtensions.cs:59](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportExtensions.cs#L59)

Streams selected EPUB chapter images without retaining earlier payloads.

Parameters

**source OfficeIMO.Epub.EpubDocument required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**consumer OfficeIMO.Drawing.OfficeImageExportConsumer required**

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

ToImagesAsync 3 overloads

`public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(EpubDocument document, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toimagesasync-officeimo-epub-epubdocument-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken)

[EpubDocument.ImageBatchConversion.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubDocument.ImageBatchConversion.cs#L17)

Renders a batch asynchronously using the same options and evidence contract.

Parameters

**document OfficeIMO.Epub.EpubDocument required**

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<IReadOnlyList<OfficeImageExportResult>>`

`public static async Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(EpubDocument source, OfficeImageExportFormat format, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toimagesasync-officeimo-epub-epubdocument-officeimo-drawing-officeimageexportformat-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken)

Asynchronously exports selected EPUB chapters and resolves retained package resources.

Parameters

**source OfficeIMO.Epub.EpubDocument required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<IReadOnlyList<OfficeImageExportResult>>`

`public static async Task ToImagesAsync(EpubDocument source, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#member-88a7bfb833e7c0d5179697c2)

Asynchronously streams selected EPUB chapter images.

Parameters

**source OfficeIMO.Epub.EpubDocument required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer required**

**options OfficeIMO.Epub.Image.EpubImageExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:26202A6D66DD6EA2F9DEA3DE469EFDE4E26EB2EEBB4298E973558EC8EF5E1618 -->
