K4 InDesign Javascript API Documentation

XMLXMLExportMap

A mapping object that maps a style (paragraph, character, table, or cell) to an XML tag.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
includeEmptyStories bool If true, includes empty stories when mapping styles to tags. read-write
includeMasterPageStories bool If true, includes stories on master spreads when mapping styles to tags. read-write
includePasteboardStories bool If true, includes stories on the pasteboard when mapping styles to tags. read-write
index number The index of the XMLExportMap within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
mappedStyle The style mapped to the XML tag. Can return: ParagraphStyle, CharacterStyle, TableStyle or CellStyle. Can also accept: String. read-only
markupTag XMLTag The XML tag applied to the element. Can also accept: String. read-write
parent The parent of the XMLExportMap (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → XMLExportMap
remove(
)
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(
)
  → XMLExportMap
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the XMLExportMap.
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 XMLExportMap.
toSpecifier(
)
  → string
Retrieves the object specifier.