# EpubImageExportOptions

HTML-backed EPUB chapter image-export options.

Class 

`OfficeIMO.Epub.Image`

**Namespace**

`OfficeIMO.Epub.Image`

**Assembly**

`OfficeIMO.Epub.Image`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

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

**Base**

`HtmlRenderOptions`

**Modifiers**

sealed

HTML-backed EPUB chapter image-export options.

## Inheritance

- HtmlRenderOptions
- EpubImageExportOptions

## Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 1

- Method [EpubImageExportOptions.CloneEpub](/api/epub-image/officeimo-epub-image-epubimageexportoptions/#method-cloneepub)

### Accepted by parameters 6

- Method [EpubImageExportExtensions.InspectFixedLayoutPage](/api/epub-image/officeimo-epub-image-epubimageexportextensions/#method-inspectfixedlayoutpage-officeimo-epub-epubdocument-int32-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken) parameter `options`
- Method [EpubImageExportExtensions.InspectFixedLayoutRegions](/api/epub-image/officeimo-epub-image-epubimageexportextensions/#method-inspectfixedlayoutregions-officeimo-epub-epubdocument-int32-collections-generic-ireadonlylist-system-string-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken) parameter `options`
- Method [EpubImageExportExtensions.SaveAsImages](/api/epub-image/officeimo-epub-image-epubimageexportextensions/#method-saveasimages-officeimo-epub-epubdocument-string-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken) parameter `options`
- Method [EpubImageExportExtensions.SaveAsImagesAsync](/api/epub-image/officeimo-epub-image-epubimageexportextensions/#method-saveasimagesasync-officeimo-epub-epubdocument-string-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken) parameter `options`
- Method [EpubImageExportExtensions.ToImages](/api/epub-image/officeimo-epub-image-epubimageexportextensions/#method-toimages-officeimo-epub-epubdocument-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken) parameter `options`
- Method [EpubImageExportExtensions.ToImagesAsync](/api/epub-image/officeimo-epub-image-epubimageexportextensions/#method-toimagesasync-officeimo-epub-epubdocument-officeimo-epub-image-epubimageexportoptions-threading-cancellationtoken) parameter `options`

Filter members 

Show inherited

## Constructors

`public EpubImageExportOptions()` [#](#constructor-ctor)

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

Creates one continuous preview per chapter; paged output remains available through the shared mode setting.

## Methods

`public override HtmlRenderOptions Clone()` [#](#method-clone)

[EpubImageExportOptions.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportOptions.cs#L33)

Creates an independent options snapshot.

Returns

`HtmlRenderOptions`

`public EpubImageExportOptions CloneEpub()` [#](#method-cloneepub)

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

Creates an independent EPUB options snapshot.

Returns

`EpubImageExportOptions`

## Inherited Methods

`public OfficeImageExportResult EnsureAccepted(OfficeImageExportResult result)` [#](#method-ensureaccepted-officeimageexportresult)

Inherited from OfficeImageExportOptions

Parameters

**result OfficeImageExportResult required**

Returns

`OfficeImageExportResult`

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

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public double GetEffectiveScale(double logicalWidth, double logicalHeight)` [#](#method-geteffectivescale-double-double)

Inherited from OfficeImageExportOptions

Parameters

**logicalWidth double required**

**logicalHeight double required**

Returns

`double`

`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?`

`public HtmlRenderOptions UseBrowserUserAgentStyles()` [#](#method-usebrowseruseragentstyles)

Inherited from HtmlRenderOptions

Returns

`HtmlRenderOptions`

`public HtmlRenderOptions UseTextHyphenationLexicon(OfficeTextHyphenationLexicon? lexicon)` [#](#method-usetexthyphenationlexicon-officetexthyphenationlexicon)

Inherited from HtmlRenderOptions

Parameters

**lexicon OfficeTextHyphenationLexicon? required**

Returns

`HtmlRenderOptions`

## Properties

`public int ChapterIndex { get; set; }` [#](#property-chapterindex)

[EpubImageExportOptions.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportOptions.cs#L11)

Zero-based first chapter to export.

`public int? ChapterCount { get; set; }` [#](#property-chaptercount)

[EpubImageExportOptions.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportOptions.cs#L14)

Maximum chapter count, or null for every remaining chapter.

`public bool IncludeChapterTitle { get; set; }` [#](#property-includechaptertitle)

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

Adds a chapter heading when the raw chapter markup does not already expose one.

`public bool IncludePackageDiagnostics { get; set; }` [#](#property-includepackagediagnostics)

[EpubImageExportOptions.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub.Image/EpubImageExportOptions.cs#L20)

Maps EPUB package diagnostics into every exported result.

## Inherited Properties

`public int PageIndex { get; set; }` [#](#property-pageindex)

Inherited from HtmlRenderOptions

`public IReadOnlyList<int>? PageSelection { get; set; }` [#](#property-pageselection)

Inherited from HtmlRenderOptions

`public HtmlRenderMode Mode { get; set; }` [#](#property-mode)

Inherited from HtmlRenderOptions

`public HtmlRenderFidelityPolicy FidelityPolicy { get; set; }` [#](#property-fidelitypolicy)

Inherited from HtmlRenderOptions

`public bool? ProjectSerializedShadowRoots { get; set; }` [#](#property-projectserializedshadowroots)

Inherited from HtmlRenderOptions

`public double ViewportWidth { get; set; }` [#](#property-viewportwidth)

Inherited from HtmlRenderOptions

`public double? ViewportHeight { get; set; }` [#](#property-viewportheight)

Inherited from HtmlRenderOptions

`public OfficePageSize PageSize { get; set; }` [#](#property-pagesize)

Inherited from HtmlRenderOptions

`public bool HonorCssPageRules { get; set; }` [#](#property-honorcsspagerules)

Inherited from HtmlRenderOptions

`public HtmlRenderMargins Margins { get; set; }` [#](#property-margins)

Inherited from HtmlRenderOptions

`public string DefaultFontFamily { get; set; }` [#](#property-defaultfontfamily)

Inherited from HtmlRenderOptions

`public bool AllowSystemFontFallback { get; set; }` [#](#property-allowsystemfontfallback)

Inherited from HtmlRenderOptions

`public double DefaultFontSize { get; set; }` [#](#property-defaultfontsize)

Inherited from HtmlRenderOptions

`public double DefaultLineHeight { get; set; }` [#](#property-defaultlineheight)

Inherited from HtmlRenderOptions

`public HtmlRenderUserAgentStyleMode UserAgentStyles { get; set; }` [#](#property-useragentstyles)

Inherited from HtmlRenderOptions

`public OfficeTextHyphenationCallback? TextHyphenationCallback { get; set; }` [#](#property-texthyphenationcallback)

Inherited from HtmlRenderOptions

`public HtmlRenderMediaFeatures MediaFeatures { get; set; }` [#](#property-mediafeatures)

Inherited from HtmlRenderOptions

`public IList<string> AdditionalStylesheets { get; }` [#](#property-additionalstylesheets)

Inherited from HtmlRenderOptions

`public Uri? BaseUri { get; set; }` [#](#property-baseuri)

Inherited from HtmlRenderOptions

`public HtmlUrlPolicy UrlPolicy { get; set; }` [#](#property-urlpolicy)

Inherited from HtmlRenderOptions

`public HtmlUrlPolicy? ResourceUrlPolicy { get; set; }` [#](#property-resourceurlpolicy)

Inherited from HtmlRenderOptions

`public HtmlRenderResourceResolver? ResourceResolver { get; set; }` [#](#property-resourceresolver)

Inherited from HtmlRenderOptions

`public TimeSpan ResourceTimeout { get; set; }` [#](#property-resourcetimeout)

Inherited from HtmlRenderOptions

`public int MaxConcurrentResourceLoads { get; set; }` [#](#property-maxconcurrentresourceloads)

Inherited from HtmlRenderOptions

`public long MaxResourceBytes { get; set; }` [#](#property-maxresourcebytes)

Inherited from HtmlRenderOptions

`public long MaxTotalResourceBytes { get; set; }` [#](#property-maxtotalresourcebytes)

Inherited from HtmlRenderOptions

`public int MaxResourceCount { get; set; }` [#](#property-maxresourcecount)

Inherited from HtmlRenderOptions

`public int MaxResourceRequests { get; set; }` [#](#property-maxresourcerequests)

Inherited from HtmlRenderOptions

`public int MaxStylesheetImportDepth { get; set; }` [#](#property-maxstylesheetimportdepth)

Inherited from HtmlRenderOptions

`public int MaxSurfaceWidth { get; set; }` [#](#property-maxsurfacewidth)

Inherited from HtmlRenderOptions

`public int MaxSurfaceHeight { get; set; }` [#](#property-maxsurfaceheight)

Inherited from HtmlRenderOptions

`public int MaxPageCount { get; set; }` [#](#property-maxpagecount)

Inherited from HtmlRenderOptions

`public int MaxProjectedVisuals { get; set; }` [#](#property-maxprojectedvisuals)

Inherited from HtmlRenderOptions

`public int MaxLayoutDepth { get; set; }` [#](#property-maxlayoutdepth)

Inherited from HtmlRenderOptions

`public int MaxInputCharacters { get; set; }` [#](#property-maxinputcharacters)

Inherited from HtmlRenderOptions

`public int MaxHtmlNodes { get; set; }` [#](#property-maxhtmlnodes)

Inherited from HtmlRenderOptions

`public int MaxBackgroundImageTiles { get; set; }` [#](#property-maxbackgroundimagetiles)

Inherited from HtmlRenderOptions

`public int MaxBackgroundImageLayers { get; set; }` [#](#property-maxbackgroundimagelayers)

Inherited from HtmlRenderOptions

`public int MaxBoxShadowLayers { get; set; }` [#](#property-maxboxshadowlayers)

Inherited from HtmlRenderOptions

`public int MaxTextShadowLayers { get; set; }` [#](#property-maxtextshadowlayers)

Inherited from HtmlRenderOptions

`public int MaxLeaderCharacters { get; set; }` [#](#property-maxleadercharacters)

Inherited from HtmlRenderOptions

`public int MaxSvgForeignObjectDepth { get; set; }` [#](#property-maxsvgforeignobjectdepth)

Inherited from HtmlRenderOptions

`public int MaxSvgForeignObjectHtmlNodes { get; set; }` [#](#property-maxsvgforeignobjecthtmlnodes)

Inherited from HtmlRenderOptions

`public int MaxFrameDepth { get; set; }` [#](#property-maxframedepth)

Inherited from HtmlRenderOptions

`public int MaxGradientStops { get; set; }` [#](#property-maxgradientstops)

Inherited from HtmlRenderOptions

`public int ConicGradientQualitySegments { get; set; }` [#](#property-conicgradientqualitysegments)

Inherited from HtmlRenderOptions

`public int MaxGridTracks { get; set; }` [#](#property-maxgridtracks)

Inherited from HtmlRenderOptions

`public int MaxColumnCount { get; set; }` [#](#property-maxcolumncount)

Inherited from HtmlRenderOptions

`public int MaxTableRows { get; set; }` [#](#property-maxtablerows)

Inherited from HtmlRenderOptions

`public int MaxTableColumns { get; set; }` [#](#property-maxtablecolumns)

Inherited from HtmlRenderOptions

`public int MaxCollapsedTableBorderSegments { get; set; }` [#](#property-maxcollapsedtablebordersegments)

Inherited from HtmlRenderOptions

`public int MaxLayoutOperations { get; set; }` [#](#property-maxlayoutoperations)

Inherited from HtmlRenderOptions

`public int MaxRunningStringCharacters { get; set; }` [#](#property-maxrunningstringcharacters)

Inherited from HtmlRenderOptions

`public HtmlCssMediaContext MediaContext { get; }` [#](#property-mediacontext)

Inherited from HtmlRenderOptions

`public double PageWidth { get; }` [#](#property-pagewidth)

Inherited from HtmlRenderOptions

`public double PageHeight { get; }` [#](#property-pageheight)

Inherited from HtmlRenderOptions

`public OfficeImageExportFormat Format { get; set; }` [#](#property-format)

Inherited from OfficeImageExportOptions

`public OfficePageSelector? PageSelector { get; set; }` [#](#property-pageselector)

Inherited from OfficeImageExportOptions

`public OfficeImageExportFileConflictPolicy FileConflictPolicy { get; set; }` [#](#property-fileconflictpolicy)

Inherited from OfficeImageExportOptions

`public bool FailOnLoss { get; set; }` [#](#property-failonloss)

Inherited from OfficeImageExportOptions

`public double Scale { get; set; }` [#](#property-scale)

Inherited from OfficeImageExportOptions

`public int? MaximumOutputWidth { get; set; }` [#](#property-maximumoutputwidth)

Inherited from OfficeImageExportOptions

`public int? MaximumOutputHeight { get; set; }` [#](#property-maximumoutputheight)

Inherited from OfficeImageExportOptions

`public OfficeColor BackgroundColor { get; set; }` [#](#property-backgroundcolor)

Inherited from OfficeImageExportOptions

`public OfficeRasterEncodingOptions RasterEncoding { get; set; }` [#](#property-rasterencoding)

Inherited from OfficeImageExportOptions

`public bool SvgTextAsPaths { get; set; }` [#](#property-svgtextaspaths)

Inherited from OfficeImageExportOptions

`public long MaximumRasterPixels { get; set; }` [#](#property-maximumrasterpixels)

Inherited from OfficeImageExportOptions

`public OfficeRasterOverflowBehavior RasterOverflowBehavior { get; set; }` [#](#property-rasteroverflowbehavior)

Inherited from OfficeImageExportOptions

`public IOfficeRasterImageCodec? ImageCodec { get; set; }` [#](#property-imagecodec)

Inherited from OfficeImageExportOptions

`public double? TargetDpi { get; set; }` [#](#property-targetdpi)

Inherited from OfficeImageExportOptions

`public OfficeFontFaceCollection Fonts { get; set; }` [#](#property-fonts)

Inherited from OfficeImageExportOptions

`public IOfficeTextShapingProvider? TextShapingProvider { get; set; }` [#](#property-textshapingprovider)

Inherited from OfficeImageExportOptions

`public string? TextShapingLanguage { get; set; }` [#](#property-textshapinglanguage)

Inherited from OfficeImageExportOptions

`public OfficeImageExportPolicy Policy { get; set; }` [#](#property-policy)

Inherited from OfficeImageExportOptions

`public IProgress<OfficeImageExportProgress>? Progress { get; set; }` [#](#property-progress)

Inherited from OfficeImageExportOptions

`public int MaximumOutputCount { get; set; }` [#](#property-maximumoutputcount)

Inherited from OfficeImageExportOptions

`public long MaximumTotalRasterPixels { get; set; }` [#](#property-maximumtotalrasterpixels)

Inherited from OfficeImageExportOptions

`public long MaximumTotalEncodedBytes { get; set; }` [#](#property-maximumtotalencodedbytes)

Inherited from OfficeImageExportOptions

`public TimeSpan RenderTimeout { get; set; }` [#](#property-rendertimeout)

Inherited from OfficeImageExportOptions

`public int MaximumDegreeOfParallelism { get; set; }` [#](#property-maximumdegreeofparallelism)

Inherited from OfficeImageExportOptions

`public virtual double LogicalUnitsPerInch { get; }` [#](#property-logicalunitsperinch)

Inherited from OfficeImageExportOptions

<!-- PowerForge markdown artifact sha256:71FB5E0595D7C1D2543C7A4DB5F4EBBBCC6D2F095DA4183284ABDAC1E4212AF2 -->
