com.groupdocs.editor.options

Class EbookSaveOptions

java.lang.Object

com.groupdocs.editor.options.EbookSaveOptions

All Implemented Interfaces:

ISaveOptions

public final class EbookSaveOptions
extends Object
implements ISaveOptions

Allows to specify custom options for generating and saving the document in all supportable e-Book formats: ePub, MOBI, and AZW3.

Supported E-book formats:

1. ePub (Electronic Publication)
2. MOBI (MobiPocket)
3. AZW3 (Kindle Format 8t)

Constructor Summary

Constructors

Constructor and Description
EbookSaveOptions() This parameterless constructor creates a new instance of EbookSaveOptions with ePub output format (can be modified then through OutputFormat(getOutputFormat()/setOutputFormat(EBookFormats)) property)
EbookSaveOptions(EBookFormats outputFormat) Creates a new instance of EbookSaveOptions with specified mandatory e-Book output format, while all other parameters are default

Method Summary

Modifier and Type	Method and Description
boolean	getExportDocumentProperties() Specifies whether to export built-in and custom document properties in resultant file.
EBookFormats	getOutputFormat() Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.
int	getSplitHeadingLevel() Specifies the maximum level of headings at which to split the e-Book file.
void	setExportDocumentProperties(boolean value) Specifies whether to export built-in and custom document properties in resultant file.
void	setOutputFormat(EBookFormats value) Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.
void	setSplitHeadingLevel(int value) Specifies the maximum level of headings at which to split the e-Book file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EbookSaveOptions

public EbookSaveOptions()

This parameterless constructor creates a new instance of EbookSaveOptions with ePub output format (can be modified then through OutputFormat(getOutputFormat()/setOutputFormat(EBookFormats)) property)

EbookSaveOptions

public EbookSaveOptions(EBookFormats outputFormat)

Creates a new instance of EbookSaveOptions with specified mandatory e-Book output format, while all other parameters are default

Parameters:

outputFormat - andatory output format, in which the e-Book should be saved

Method Detail

getExportDocumentProperties

public final boolean getExportDocumentProperties()

Specifies whether to export built-in and custom document properties in resultant file. Default value is false.

getOutputFormat

public final EBookFormats getOutputFormat()

Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.

getSplitHeadingLevel

public final int getSplitHeadingLevel()

Specifies the maximum level of headings at which to split the e-Book file. Default value is 2. Setting it to 0 will disable splitting, so all content of the e-Book will be incorporarted into a single package inside the resultant file.

When this property is set to a value from 1 to 9, the document will be split at paragraphs formatted using <b>Heading 1</b>, <b>Heading 2</b> , <b>Heading 3</b> etc. styles up to the specified heading level.

By default, only <b>Heading 1</b> and <b>Heading 2</b> paragraphs cause the document to be split. Setting this property to zero (or lesser then zero) will cause the document not to be split at heading paragraphs at all.

setExportDocumentProperties

public final void setExportDocumentProperties(boolean value)

Specifies whether to export built-in and custom document properties in resultant file. Default value is false.

setOutputFormat

public final void setOutputFormat(EBookFormats value)

Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.

setSplitHeadingLevel

public final void setSplitHeadingLevel(int value)

Specifies the maximum level of headings at which to split the e-Book file. Default value is 2. Setting it to 0 will disable splitting, so all content of the e-Book will be incorporarted into a single package inside the resultant file.

When this property is set to a value from 1 to 9, the document will be split at paragraphs formatted using <b>Heading 1</b>, <b>Heading 2</b> , <b>Heading 3</b> etc. styles up to the specified heading level.

By default, only <b>Heading 1</b> and <b>Heading 2</b> paragraphs cause the document to be split. Setting this property to zero (or lesser then zero) will cause the document not to be split at heading paragraphs at all.