Class EpubWriteSettings

Namespace

DocWright.Formats.Epub

Assembly

DocWright.Formats.Epub.dll

Format-specific settings for EpubWriter.

public sealed class EpubWriteSettings

Inheritance

object

EpubWriteSettings

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Callers who construct the writer directly should use this, which is strongly typed. Callers routing through DocWrightConverter.Save(document, stream, ".epub", options) reach the same settings through the format-neutral SaveOptions.FormatSettings string dictionary — see EpubFormatSettingKeys. Anything set there overrides what is set here.

Grows additively, like every other option bag in the library.

Constructors

EpubWriteSettings()

Properties

HeadingLevel

Gets or sets the deepest heading level that starts a new content document, 1–9. Defaults to 1. Only consulted when Split is Heading.

Identifier

Gets or sets the value written as dc:identifier, or null to derive one from the content — the default.

Language

Gets or sets the value written as dc:language. Defaults to "en".

Modified

Gets or sets the value written as <meta property="dcterms:modified">, in the YYYY-MM-DDTHH:MM:SSZ form EPUB requires. Defaults to 2000-01-01T00:00:00Z.

Split

Gets or sets where content documents are split. Defaults to Heading.

Title

Gets or sets the value written as dc:title, or null to take the document's first heading — the default.

Methods

Clone()

Creates a copy, so a writer can apply per-call overrides without mutating the instance its caller handed it.