InDesign2026
API 21.5.1.73
Object

EPubExportPreference

EPub export preferences.

Preference EPubExportPreference
Hierarchy

Book | Document

EPubExportPreference

Properties

NameType AccessDescription
Number read/write Bottom margin of the epub.
Boolean read/write If true, break InDesign document into smaller piece when generating epub.
BulletListExportOption
read/write The bullet export option.
String read/write The epub cover image file path.
ImageSizeOption
read/write Allows user to select the image size option for conversion
Boolean read/write If true, embed font in epub.
String read/write The epub accessibility certified by.
String read/write The epub accessibility conforms to.
String read/write The epub accessibility credentials.
String read/write The epub accessibility feature.
String read/write The epub accessibility hazard.
String read/write The epub accessibility mode.
String read/write The epub accessibility mode sufficient.
String read/write The epub accessibility summary.
EpubCover
read/write The epub cover option.
Boolean read/write If true, The epub create page navigation.
String read/write The epub creator.
String read/write The epub date.
String read/write The epub description.
String read/write The epub publisher.
String read/write The epub rights.
String read/write The epub subject.
String read/write The epub title.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
ExportOrder
read/write The export order.
String[] read/write The file path of external cascading style sheets.
EPubFootnotePlacement
read/write The placement of footnote for EPub export
Boolean read/write If true, InDesign will generate cascade style sheet.
Boolean read/write If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
GIFOptionsPalette
read/write The color palette for GIF conversion. Note: Not valid when image conversion is JPEG.
String read/write The epub unique identifier, like ISBN.
Boolean read/write ignore object level image conversion settings.
ImageAlignmentType
read/write Alignment applied to images
ImageConversion
read/write The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true.
ImageResolution
read/write The export resolution
ImagePageBreakType
read/write Image page break settings to be used with objects
Number 0–8640 read/write Space After applied to images
Number 0–8640 read/write Space Before applied to images
Boolean read/write If true, InDesign will generate class attributes for elements in HTML, else will generate plain html without class attributes.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String[] read/write The file path of external javascripts.
JPEGOptionsFormat
read/write The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.
JPEGOptionsQuality
read/write The quality of converted JPEG images. Note: Not valid when image conversion is GIF.
Number read/write Left margin of the epub.
Number readonly The PNG compression level.
NumberedListExportOption
read/write The numbered list export option.
String read/write The name of paragraph style to break InDesign document.
Book | Document readonly The parent of the EPubExportPreference (a Book or Document).
Boolean read/write If true, format image based on layout appearence.
Boolean read/write If true, output local style override.
Object read/write A property that allows setting of several properties at the same time.
Number read/write Right margin of the epub.
Boolean read/write If true, strip soft return.
String read/write The name of TOC style to generate epub TOC.
Number read/write Top margin of the epub.
Boolean read/write If true, InDesign will use existing image for graphic objects on export.
Boolean read/write If true, image page break settings will be used in objects
UseSVGAsEnum
read/write Use SVG As
EpubVersion
read/write The version of EPUB.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
EPubExportPreference[]

Resolves the object specifier, creating an array of object references.

Boolean

Removes the event listener.

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.
String

Generates a string which, if executed, will return the EPubExportPreference.

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a EPubExportPreference.

Return 1

Methods that return a EPubExportPreference.