EPub export preferences.
Go to Property Listing | Method Listing
toSource, getElements, toSpecifier, addEventListener, removeEventListener
Book, Boolean, BulletListExportOption, Document, EpubCover, EpubVersion, EventListeners, Events, ExportOrder, GIFOptionsPalette, ImageAlignmentType, ImageConversion, ImagePageBreakType, ImageResolution, ImageSizeOption, JPEGOptionsFormat, JPEGOptionsQuality, Number, NumberedListExportOption, Object, String,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
applyImageAlignmentToAnchoredObjectSettings |
read/write |
apply image alignment to anchored object settings. |
|
|
bottomMargin |
read/write |
Bottom margin of the epub. |
|
|
breakDocument |
read/write |
If true, break InDesign document into smaller piece when generating epub. |
|
|
bulletExportOption |
BulletListExportOption.UNORDERED_LIST BulletListExportOption.AS_TEXT |
read/write |
The bullet export option. |
|
coverImageFile |
read/write |
The epub cover image file path. |
|
|
customImageSizeOption |
ImageSizeOption.SIZE_FIXED ImageSizeOption.SIZE_RELATIVE_TO_PAGE_WIDTH |
read/write |
Allows user to select the image size option for conversion |
|
embedFont |
read/write |
If true, embed font in epub. |
|
|
epubCover |
EpubCover.NONE EpubCover.FIRST_PAGE EpubCover.EXTERNAL_IMAGE |
read/write |
The epub cover option. |
|
epubPublisher |
read/write |
The epub publisher. |
|
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
exportOrder |
ExportOrder.LAYOUT_ORDER ExportOrder.ARTICLE_PANEL_ORDER ExportOrder.XML_STRUCTURE_ORDER |
read/write |
The export order. |
|
externalStyleSheets |
read/write |
The file path of external cascading style sheets. |
|
|
footnoteFollowParagraph |
read/write |
If true, output footnote immediately after its paragraph. |
|
|
gifOptionsInterlaced |
read/write |
If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG. |
|
|
gifOptionsPalette |
GIFOptionsPalette.ADAPTIVE_PALETTE GIFOptionsPalette.MACINTOSH_PALETTE GIFOptionsPalette.WEB_PALETTE GIFOptionsPalette.WINDOWS_PALETTE |
read/write |
The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. |
|
id |
read/write |
The epub unique identifier, like ISBN. |
|
|
ignoreObjectConversionSettings |
read/write |
ignore object level image conversion settings. |
|
|
imageAlignment |
ImageAlignmentType.ALIGN_LEFT ImageAlignmentType.ALIGN_CENTER ImageAlignmentType.ALIGN_RIGHT |
read/write |
Alignment applied to images |
|
imageConversion |
ImageConversion.AUTOMATIC ImageConversion.JPEG ImageConversion.GIF ImageConversion.PNG |
read/write |
The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true. |
|
imageExportResolution |
ImageResolution.PPI_72 ImageResolution.PPI_96 ImageResolution.PPI_150 ImageResolution.PPI_300 |
read/write |
The export resolution |
|
imagePageBreak |
ImagePageBreakType.PAGE_BREAK_BEFORE ImagePageBreakType.PAGE_BREAK_AFTER ImagePageBreakType.PAGE_BREAK_BEFORE_AND_AFTER |
read/write |
Image page break settings to be used with objects |
|
imageSpaceAfter |
Number (range 0 - 8640) |
read/write |
Space After applied to images |
|
imageSpaceBefore |
Number (range 0 - 8640) |
read/write |
Space Before applied to images |
|
includeCSSDefinition |
read/write |
If true, include CSS definition. |
|
|
includeDocumentMetadata |
read/write |
If true, output document metadata into epub. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
javascripts |
read/write |
The file path of external javascripts. |
|
|
jpegOptionsFormat |
JPEGOptionsFormat.BASELINE_ENCODING JPEGOptionsFormat.PROGRESSIVE_ENCODING |
read/write |
The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. |
|
jpegOptionsQuality |
JPEGOptionsQuality.LOW JPEGOptionsQuality.MEDIUM JPEGOptionsQuality.HIGH JPEGOptionsQuality.MAXIMUM |
read/write |
The quality of converted JPEG images. Note: Not valid when image conversion is GIF. |
|
leftMargin |
read/write |
Left margin of the epub. |
|
|
level |
read/write |
The PNG compression level. |
|
|
numberedListExportOption |
NumberedListExportOption.ORDERED_LIST NumberedListExportOption.STATIC_ORDERED_LIST NumberedListExportOption.AS_TEXT |
read/write |
The numbered list export option. |
|
paragraphStyleName |
read/write |
The name of paragraph style to break InDesign document. |
|
|
parent |
readonly |
The parent of the EPubExportPreference (a Book or Document). |
|
|
preserveLayoutAppearence |
read/write |
If true, format image based on layout appearence. |
|
|
preserveLocalOverride |
read/write |
If true, output local style override. |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
rightMargin |
read/write |
Right margin of the epub. |
|
|
stripSoftReturn |
read/write |
If true, strip soft return. |
|
|
tocStyleName |
read/write |
The name of TOC style to generate epub TOC. |
|
|
topMargin |
read/write |
Top margin of the epub. |
|
|
useImagePageBreak |
read/write |
If true, image page break settings will be used in objects |
|
|
version |
EpubVersion.EPUB2 EpubVersion.EPUB3 EpubVersion.EPUB3_WITH_LAYOUT |
read/write |
The version of EPUB. |
|
viewDocumentAfterExport |
read/write |
If true, open docuemnt in viewer after export. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
EPubExportPreference getElements ()
Resolves the object specifier, creating an array of object references.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the EPubExportPreference.
String toSpecifier ()
Retrieves the object specifier.
Document.epubExportPreferences
Book.epubExportPreferences
Event.parent
EventListener.parent
MutationEvent.parent