K4 InDesign Javascript API Documentation

PreferencesXMLImportPreference

XML import preferences.

Extends

Instance Properties

Name Description Access
allowTransform bool If true, transforms the XML using an XSLT file. read-write
createLinkToXML bool If true, creates a link to the imported XML file. If false, embeds the file. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
ignoreUnmatchedIncoming bool If true, ignores elements that do not match the existing structure. Note: Valid only when import style is merge. read-write
ignoreWhitespace bool If true, leaves existing content in place if the matching XML content contains only whitespace characters such as a carriage return or a tab character. Note: Valid only when import style is merge. read-write
importCALSTables = true bool If true, imports CALS tables as InDesign tables. read-write
importStyle XMLImportStyles The style of incorporating imported XML content into the document. read-write
importTextIntoTables bool If true, imports text into tables if tags match placeholder tables and their cells. Note: Valid only when import style is merge. read-write
importToSelected bool If true, imports into the selected XML element. If false, imports at the root element. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the XMLImportPreference (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
removeUnmatchedExisting bool If true, deletes existing elements or placeholders in the document that do not have matches in the XML file. Note: Valid only when import style is merge. read-write
repeatTextElements bool If true, repeating text elements inherit the formatting applied to placeholder text. Note: Valid only when import style is merge. read-write
transformFilename The name of the XSLT file. Note: Valid when allow transform is true. Can return: File or XMLTransformFile enumerator. read-write
transformParameters Stylesheet parameters as a list of name/value pairs in the format [[name, value], [name, value], ...]. Can return: Ordered array containing name:String, value:String. read-write

Methods

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