K4 InDesign Javascript API Documentation

PreferencesPublishExportPreference

Publish export preferences.

Extends

Instance Properties

Name Description Access
coverImageFile string The epub cover image file path. read-write
coverPage string The cover page. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
gifOptionsPalette GIFOptionsPalette The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. read-write
imageConversion ImageConversion The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true. read-write
imageExportResolution ImageResolution The export resolution read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
jpegOptionsQuality JPEGOptionsQuality The quality of converted JPEG images. Note: Not valid when image conversion is GIF. read-write
parent Document The parent of the PublishExportPreference (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
publishCover PublishCoverEnum The publish cover option. read-write
publishDescription string The publish description. read-write
publishFileName string The file name. read-write
publishFormat PublishFormatEnum the publish format. read-write
publishPageRange string The publish page range. read-write
publishPageRangeFormat PageRangeFormat The publish page range format. read-write
publishPdf bool If PDF should be uploaded while publishing. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → PublishExportPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → PublishExportPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the PublishExportPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.