EPubExportPreference

EPub export preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

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

Hierarchy:

Superclass: Preference

Class: EPubExportPreference

Property Listing

Property

Type

Access

Description

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_TEXT_FLOW

read/write

Allows user to select the image size option for conversion

embedFont

Boolean

read/write

If true, embed font in epub.

epubAccessibilityCertifiedBy

String

read/write

The epub accessibility certified by.

epubAccessibilityConformsTo

String

read/write

The epub accessibility conforms to.

epubAccessibilityCredentials

String

read/write

The epub accessibility credentials.

epubAccessibilityFeature

String

read/write

The epub accessibility feature.

epubAccessibilityHazard

String

read/write

The epub accessibility hazard.

epubAccessibilityMode

String

read/write

The epub accessibility mode.

epubAccessibilityModeSufficient

String

read/write

The epub accessibility mode sufficient.

epubAccessibilityReportLink

String

read/write

The epub accessibility report link.

epubAccessibilitySummary

String

read/write

The epub accessibility summary.

epubCover

EpubCover

EpubCover.EXTERNAL_IMAGE

EpubCover.FIRST_PAGE

EpubCover.NONE

read/write

The epub cover option.

epubCreatePageNavigation

Boolean

read/write

If true, The epub create page navigation.

epubCreator

String

read/write

The epub creator.

epubDate

String

read/write

The epub date.

epubDescription

String

read/write

The epub description.

epubPublisher

String

read/write

The epub publisher.

epubRights

String

read/write

The epub rights.

epubSubject

String

read/write

The epub subject.

epubTitle

String

read/write

The epub title.

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.

footnotePlacement

EPubFootnotePlacement

EPubFootnotePlacement.FOOTNOTE_AFTER_PARAGRAPH

EPubFootnotePlacement.FOOTNOTE_AFTER_STORY

EPubFootnotePlacement.FOOTNOTE_INSIDE_POPUP

read/write

The placement of footnote for EPub export

generateCascadeStyleSheet

Boolean

read/write

If true, InDesign will generate cascade style sheet.

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

includeClassesInHTML

Boolean

read/write

If true, InDesign will generate class attributes for elements in HTML, else will generate plain html without class attributes.

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

readonly

The PNG compression level.

numberedListExportOption

NumberedListExportOption

NumberedListExportOption.AS_TEXT

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

useExistingImageOnExport

Boolean

read/write

If true, InDesign will use existing image for graphic objects on export.

useImagePageBreak

Boolean

read/write

If true, image page break settings will be used in objects

useSVGAs

UseSVGAsEnum

UseSVGAsEnum.EMBED_CODE

UseSVGAsEnum.OBJECT_TAGS

read/write

Use SVG As

version

EpubVersion

EpubVersion.EPUB2

EpubVersion.EPUB3

read/write

The version of EPUB.

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)

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)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Document.epubExportPreferences

Book.epubExportPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

EPubExportPreference.getElements()