Class
XML export preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
XMLExportPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allowTransform | bool | r/w | If true, transforms the XML using an XSLT file. |
| characterReferences | bool | r/w | If true, replaces special characters with character references. |
| copyFormattedImages | bool | r/w | If true, copies formatted images to the images subfolder. |
| copyOptimizedImages | bool | r/w | If true, copies optimized images to the images subfolder. |
| copyOriginalImages | bool | r/w | If true, copies original images to the images subfolder. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| excludeDtd | bool | r/w | If true, excludes the DTD from the exported XML content. |
| exportFromSelected | bool | r/w | If true, exports XML content from the selected XML element. If false, exports the entire document. |
| exportUntaggedTablesFormat | XMLExportUntaggedTablesFormat: XMLExportUntaggedTablesFormat.NONE XMLExportUntaggedTablesFormat.CALS |
r/w | The export format for untagged tables in tagged stories. (default: XMLExportUntaggedTablesFormat.CALS) |
| fileEncoding | XMLFileEncoding: XMLFileEncoding.UTF8 XMLFileEncoding.UTF16 XMLFileEncoding.SHIFT_JIS |
r/w | The file encoding type for exporting XML content. |
| gifOptionsInterlaced | bool | r/w | 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 |
r/w | The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. |
| imageConversion | ImageConversion: ImageConversion.AUTOMATIC ImageConversion.JPEG ImageConversion.GIF |
r/w | The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| jpegOptionsFormat | JPEGOptionsFormat: JPEGOptionsFormat.BASELINE_ENCODING JPEGOptionsFormat.PROGRESSIVE_ENCODING |
r/w | The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. |
| jpegOptionsQuality | JPEGOptionsQuality: JPEGOptionsQuality.LOW JPEGOptionsQuality.MEDIUM JPEGOptionsQuality.HIGH JPEGOptionsQuality.MAXIMUM |
r/w | The quality of converted JPEG images. Note: Not valid when image conversion is GIF. |
| parent | Application Document |
readonly | The parent of the XMLExportPreference (a Application or Document). |
| preferredBrowser | File NothingEnum |
r/w | The preferred browser for viewing XML. Can return: File or NothingEnum enumerator. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| ruby | bool | r/w | If true, includes Ruby text in the exported XML content. |
| transformFilename | File XMLTransformFile |
r/w | The name of the XSLT file. Note: Valid when allow transform is true. Can return: File or XMLTransformFile enumerator. |
| viewAfterExport | bool | r/w | If true, displays exported XML content in a specified viewer. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the XMLExportPreference.
Element of
Application.xmlExportPreferences
Document.xmlExportPreferences
Return
Array of XMLExportPreference XMLExportPreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |