EPubExportPreference

EPub export preferences.

Go to Property Listing | Method Listing

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, BulletListExportOption, EpubCover, EpubVersion, EventListeners, Events, ExportOrder, GIFOptionsPalette, ImageAlignmentType, ImageConversion, ImagePageBreakType, ImageResolution, ImageSizeOption, JPEGOptionsFormat, JPEGOptionsQuality, Number, NumberedListExportOption, Object, String

Hierarchy:

Superclass: Preference

Class: EPubExportPreference

Property Listing

Property	Type	Access	Description
applyImageAlignmentToAnchoredObjectSettings	Boolean	read/write	apply image alignment to anchored object settings.
bottomMargin	Number	read/write	Bottom margin of the epub.
breakDocument	Boolean	read/write	If true, break InDesign document into smaller piece when generating epub.
bulletExportOption	BulletListExportOption BulletListExportOption.AS_TEXT BulletListExportOption.UNORDERED_LIST	read/write	The bullet export option.
coverImageFile	String	read/write	The epub cover image file path.
customImageSizeOption	ImageSizeOption ImageSizeOption.SIZE_FIXED ImageSizeOption.SIZE_RELATIVE_TO_PAGE_WIDTH	read/write	Allows user to select the image size option for conversion
embedFont	Boolean	read/write	If true, embed font in epub.
epubCover	EpubCover EpubCover.EXTERNAL_IMAGE EpubCover.FIRST_PAGE EpubCover.NONE	read/write	The epub cover option.
epubPublisher	String	read/write	The epub publisher.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
exportOrder	ExportOrder ExportOrder.ARTICLE_PANEL_ORDER ExportOrder.LAYOUT_ORDER ExportOrder.XML_STRUCTURE_ORDER	read/write	The export order.
externalStyleSheets	Array of String	read/write	The file path of external cascading style sheets.
footnoteFollowParagraph	Boolean	read/write	If true, output footnote immediately after its paragraph.
gifOptionsInterlaced	Boolean	read/write	If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
gifOptionsPalette	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	String	read/write	The epub unique identifier, like ISBN.
ignoreObjectConversionSettings	Boolean	read/write	ignore object level image conversion settings.
imageAlignment	ImageAlignmentType ImageAlignmentType.ALIGN_CENTER ImageAlignmentType.ALIGN_LEFT ImageAlignmentType.ALIGN_RIGHT	read/write	Alignment applied to images
imageConversion	ImageConversion ImageConversion.AUTOMATIC ImageConversion.GIF ImageConversion.JPEG 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 ImageResolution.PPI_150 ImageResolution.PPI_300 ImageResolution.PPI_72 ImageResolution.PPI_96	read/write	The export resolution
imagePageBreak	ImagePageBreakType ImagePageBreakType.PAGE_BREAK_AFTER ImagePageBreakType.PAGE_BREAK_BEFORE 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	Boolean	read/write	If true, include CSS definition.
includeDocumentMetadata	Boolean	read/write	If true, output document metadata into epub.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
javascripts	Array of String	read/write	The file path of external javascripts.
jpegOptionsFormat	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 JPEGOptionsQuality.HIGH JPEGOptionsQuality.LOW JPEGOptionsQuality.MAXIMUM JPEGOptionsQuality.MEDIUM	read/write	The quality of converted JPEG images. Note: Not valid when image conversion is GIF.
leftMargin	Number	read/write	Left margin of the epub.
level	Number	read/write	The PNG compression level.
numberedListExportOption	NumberedListExportOption NumberedListExportOption.AS_TEXT NumberedListExportOption.ORDERED_LIST NumberedListExportOption.STATIC_ORDERED_LIST	read/write	The numbered list export option.
paragraphStyleName	String	read/write	The name of paragraph style to break InDesign document.
parent	Book Document	readonly	The parent of the EPubExportPreference (a Book or Document).
preserveLayoutAppearence	Boolean	read/write	If true, format image based on layout appearence.
preserveLocalOverride	Boolean	read/write	If true, output local style override.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rightMargin	Number	read/write	Right margin of the epub.
stripSoftReturn	Boolean	read/write	If true, strip soft return.
tocStyleName	String	read/write	The name of TOC style to generate epub TOC.
topMargin	Number	read/write	Top margin of the epub.
useImagePageBreak	Boolean	read/write	If true, image page break settings will be used in objects
version	EpubVersion EpubVersion.EPUB2 EpubVersion.EPUB3 EpubVersion.EPUB3_WITH_LAYOUT	read/write	The version of EPUB.
viewDocumentAfterExport	Boolean	read/write	If true, open docuemnt in viewer after export.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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 File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)