Adobe InCopy CS5 (7.0) Object Model JS: XMLExportMap

InCopy CS5

Class

XMLExportMap

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

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
XMLExportMap
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
includeEmptyStoriesbool r/wIf true, includes empty stories when mapping styles to tags.
includeMasterPageStoriesbool r/wIf true, includes stories on master spreads when mapping styles to tags.
includePasteboardStoriesbool r/wIf true, includes stories on the pasteboard when mapping styles to tags.
indexnumber readonlyThe index of the XMLExportMap within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
mappedStyleCellStyleCharacterStyle
ParagraphStyle
String
TableStyle
readonlyThe style mapped to the XML tag. Can return: ParagraphStyle, CharacterStyle, TableStyle or CellStyle. Can also accept: String.
markupTagString
XMLTag
r/wThe XML tag applied to the element. Can also accept: String.
parentApplication
Document
readonlyThe parent of the XMLExportMap (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

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 XMLExportMap getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the XMLExportMap.

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 XMLExportMap.

string toSpecifier ()
Retrieves the object specifier.

Used in:

XMLExportMap XMLExportMaps.nextItem (obj: XMLExportMap)

XMLExportMap XMLExportMaps.previousItem (obj: XMLExportMap)

Return

Array of XMLExportMap XMLExportMap.getElements ()

XMLExportMap XMLExportMaps.[] (index: number)

XMLExportMap XMLExportMaps.add (mappedStyle: varies, markupTag: varies[, withProperties: Object])

XMLExportMap XMLExportMaps.anyItem ()

Array of XMLExportMap XMLExportMaps.everyItem ()

XMLExportMap XMLExportMaps.firstItem ()

XMLExportMap XMLExportMaps.item (index: varies)

Array of XMLExportMap XMLExportMaps.itemByRange (from: varies, to: varies)

XMLExportMap XMLExportMaps.lastItem ()

XMLExportMap XMLExportMaps.middleItem ()

XMLExportMap XMLExportMaps.nextItem (obj: XMLExportMap)

XMLExportMap XMLExportMaps.previousItem (obj: XMLExportMap)

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