K4 InDesign Javascript API Documentation

PreferencesXMLExportPreference

XML export preferences.

Extends

Instance Properties

Name Description Access
allowTransform bool If true, transforms the XML using an XSLT file. read-write
characterReferences bool If true, replaces special characters with character references. read-write
copyFormattedImages bool If true, copies formatted images to the images subfolder. read-write
copyOptimizedImages bool If true, copies optimized images to the images subfolder. read-write
copyOriginalImages bool If true, copies original images to the images subfolder. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
excludeDtd bool If true, excludes the DTD from the exported XML content. read-write
exportFromSelected bool If true, exports XML content from the selected XML element. If false, exports the entire document. read-write
exportUntaggedTablesFormat XMLExportUntaggedTablesFormat The export format for untagged tables in tagged stories. read-write
fileEncoding XMLFileEncoding The file encoding type for exporting XML content. read-write
gifOptionsInterlaced bool If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG. read-write
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
isValid bool Returns true if the object specifier resolves to valid objects. read-only
jpegOptionsFormat JPEGOptionsFormat The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. read-write
jpegOptionsQuality JPEGOptionsQuality The quality of converted JPEG images. Note: Not valid when image conversion is GIF. read-write
parent The parent of the XMLExportPreference (a Application or Document). read-only
preferredBrowser The preferred browser for viewing XML. Can return: File or NothingEnum enumerator. read-write
properties Object A property that allows setting of several properties at the same time. read-write
ruby bool If true, includes Ruby text in the exported XML content. read-write
transformFilename The name of the XSLT file. Note: Valid when allow transform is true. Can return: File or XMLTransformFile enumerator. read-write
viewAfterExport bool If true, displays exported XML content in a specified viewer. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → XMLExportPreference
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(
)
  → XMLExportPreference
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 XMLExportPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.