Adobe InDesign CS5 Server (7.0) Object Model JS: XMLExportPreference

InDesign Server CS5

Class

XMLExportPreference

 XML export preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
XMLExportPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
allowTransformbool r/wIf true, transforms the XML using an XSLT file.
characterReferencesbool r/wIf true, replaces special characters with character references.
copyFormattedImagesbool r/wIf true, copies formatted images to the images subfolder.
copyOptimizedImagesbool r/wIf true, copies optimized images to the images subfolder.
copyOriginalImagesbool r/wIf true, copies original images to the images subfolder.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
excludeDtdbool r/wIf true, excludes the DTD from the exported XML content.
exportFromSelectedbool r/wIf true, exports XML content from the selected XML element. If false, exports the entire document.
exportUntaggedTablesFormatXMLExportUntaggedTablesFormat:
XMLExportUntaggedTablesFormat.NONE
XMLExportUntaggedTablesFormat.CALS
r/wThe export format for untagged tables in tagged stories. (default: XMLExportUntaggedTablesFormat.CALS)
fileEncodingXMLFileEncoding:
XMLFileEncoding.UTF8
XMLFileEncoding.UTF16
XMLFileEncoding.SHIFT_JIS
r/wThe file encoding type for exporting XML content.
gifOptionsInterlacedbool r/wIf true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
gifOptionsPaletteGIFOptionsPalette:
GIFOptionsPalette.ADAPTIVE_PALETTE
GIFOptionsPalette.MACINTOSH_PALETTE
GIFOptionsPalette.WEB_PALETTE
GIFOptionsPalette.WINDOWS_PALETTE
r/wThe color palette for GIF conversion. Note: Not valid when image conversion is JPEG.
imageConversionImageConversion:
ImageConversion.AUTOMATIC
ImageConversion.JPEG
ImageConversion.GIF
r/wThe file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
jpegOptionsFormatJPEGOptionsFormat:
JPEGOptionsFormat.BASELINE_ENCODING
JPEGOptionsFormat.PROGRESSIVE_ENCODING
r/wThe formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.
jpegOptionsQualityJPEGOptionsQuality:
JPEGOptionsQuality.LOW
JPEGOptionsQuality.MEDIUM
JPEGOptionsQuality.HIGH
JPEGOptionsQuality.MAXIMUM
r/wThe quality of converted JPEG images. Note: Not valid when image conversion is GIF.
parentApplication
Document
readonlyThe parent of the XMLExportPreference (a Application or Document).
preferredBrowserFile
NothingEnum
r/wThe preferred browser for viewing XML. Can return: File or NothingEnum enumerator.
propertiesObject r/wA property that allows setting of several properties at the same time.
rubybool r/wIf true, includes Ruby text in the exported XML content.
transformFilenameFile
XMLTransformFile
r/wThe name of the XSLT file. Note: Valid when allow transform is true. Can return: File or XMLTransformFile enumerator.
viewAfterExportbool r/wIf true, displays exported XML content in a specified viewer.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of XMLExportPreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the XMLExportPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.xmlExportPreferences

Document.xmlExportPreferences

Return

Array of XMLExportPreference XMLExportPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index