EbookSaveOptions Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.editor.options.ISaveOptions
public final class EbookSaveOptions 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:
| Constructor | Description |
|---|---|
| EbookSaveOptions() | This parameterless constructor creates a new instance of EbookSaveOptions with ePub output format (can be modified then through OutputFormat (#getOutputFormat.getOutputFormat/#setOutputFormat(EBookFormats).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 | Description |
|---|---|
| getSplitHeadingLevel() | Specifies the maximum level of headings at which to split the e-Book file. |
| setSplitHeadingLevel(int value) | Specifies the maximum level of headings at which to split the e-Book file. |
| getExportDocumentProperties() | Specifies whether to export built-in and custom document properties in resultant file. |
| setExportDocumentProperties(boolean value) | Specifies whether to export built-in and custom document properties in resultant file. |
| getOutputFormat() | Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3. |
| setOutputFormat(EBookFormats value) | Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3. |
public EbookSaveOptions()
This parameterless constructor creates a new instance of EbookSaveOptions with ePub output format (can be modified then through OutputFormat (#getOutputFormat.getOutputFormat/#setOutputFormat(EBookFormats).setOutputFormat(EBookFormats)) property)
public EbookSaveOptions(EBookFormats outputFormat)
Creates a new instance of EbookSaveOptions with specified mandatory e-Book output format, while all other parameters are default
Parameters:
| Parameter | Type | Description |
|---|---|---|
| outputFormat | EBookFormats | andatory output format, in which the e-Book should be saved |
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 Heading 1 , Heading 2 , Heading 3 etc. styles up to the specified heading level.
By default, only Heading 1 and Heading 2 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.
Returns: int
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 Heading 1 , Heading 2 , Heading 3 etc. styles up to the specified heading level.
By default, only Heading 1 and Heading 2 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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final boolean getExportDocumentProperties()
Specifies whether to export built-in and custom document properties in resultant file. Default value is false .
Returns: boolean
public final void setExportDocumentProperties(boolean value)
Specifies whether to export built-in and custom document properties in resultant file. Default value is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final EBookFormats getOutputFormat()
Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.
Returns: EBookFormats
public final void setOutputFormat(EBookFormats value)
Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | EBookFormats |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.