XMLExportMap

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

Methods:

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, CharacterStyle, EventListeners, Events, Number, Object, ParagraphStyle, String, TableStyle, XMLTag

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

includeEmptyStories

Boolean

read/write

If true, includes empty stories when mapping styles to tags.

includeMasterPageStories

Boolean

read/write

If true, includes stories on master spreads when mapping styles to tags.

includePasteboardStories

Boolean

read/write

If true, includes stories on the pasteboard when mapping styles to tags.

index

Number

readonly

The index of the XMLExportMap within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

mappedStyle

CharacterStyle

ParagraphStyle

TableStyle

CellStyleCanalsoaccept:String

readonly

The style mapped to the XML tag. Can return: ParagraphStyle, CharacterStyle, TableStyle or CellStyle. Can also accept: String.

markupTag

XMLTag

String

read/write

The XML tag applied to the element. Can also accept: String.

parent

Application

Document

readonly

The parent of the XMLExportMap (a Application or Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

XMLExportMap getElements ()

Resolves the object specifier, creating an array of object references.

undefined remove ()

Deletes the XMLExportMap.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the XMLExportMap.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

XMLExportMaps.add()

XMLExportMap.getElements()

XMLExportMaps.anyItem()

XMLExportMaps.everyItem()

XMLExportMaps.nextItem()

XMLExportMaps.previousItem()

XMLExportMaps.item()

XMLExportMaps.[]()

XMLExportMaps.itemByRange()

XMLExportMaps.firstItem()

XMLExportMaps.lastItem()

XMLExportMaps.middleItem()