Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

EpubImageExportExtensions

OfficeIMO.Epub.Image

Namespace
OfficeIMO.Epub.Image
Assembly
OfficeIMO.Epub.Image
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

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

Inheritance

  • object
  • EpubImageExportExtensions

Methods

public static EpubFixedLayoutInspection InspectFixedLayoutPage(EpubDocument source, int chapterIndex, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default) #

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.
public static EpubFixedLayoutInspection InspectFixedLayoutRegions(EpubDocument source, int chapterIndex, IReadOnlyList<string> regionElementIds, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default) #

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.
public static OfficeConversionReport SaveAsImages(EpubDocument document, string folderPath, EpubImageExportOptions? options = null, CancellationToken cancellationToken = default) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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