PublishExportPreference

Publish export preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, GIFOptionsPalette, ImageConversion, ImageResolution, JPEGOptionsQuality, Object, PageRangeFormat, PublishCoverEnum, PublishFormatEnum, String

Hierarchy:

Superclass: Preference

Class: PublishExportPreference

Property Listing

Property

Type

Access

Description

coverImageFile

String

read/write

The epub cover image file path.

coverPage

String

read/write

The cover page.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

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.

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

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

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.

parent

Document

readonly

The parent of the PublishExportPreference (a Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

publishCover

PublishCoverEnum

PublishCoverEnum.CHOSEN_PAGE

PublishCoverEnum.EXTERNAL_IMAGE

PublishCoverEnum.FIRST_PAGE

read/write

The publish cover option.

publishDescription

String

read/write

The publish description.

publishFileName

String

read/write

The file name.

publishFormat

PublishFormatEnum

PublishFormatEnum.PUBLISH_BY_PAGES

PublishFormatEnum.PUBLISH_BY_SPREAD

read/write

the publish format.

publishPageRange

String

read/write

The publish page range.

publishPageRangeFormat

PageRangeFormat

PageRangeFormat.EXPORT_ALL_PAGES

PageRangeFormat.EXPORT_PAGE_RANGE

read/write

The publish page range format.

publishPdf

Boolean

read/write

If PDF should be uploaded while publishing.

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)

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Document.publishExportPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

PublishExportPreference.getElements()