Adobe InCopy CS5 (7.0) Object Model JS: XMLImportMap

InCopy CS5

Class

XMLImportMap

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

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
XMLImportMap
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the XMLImportMap within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
mappedStyleCellStyleCharacterStyle
ParagraphStyle
String
TableStyle
r/wThe style mapped to the XML tag. Can return: ParagraphStyle, CharacterStyle, TableStyle or CellStyle. Can also accept: String.
markupTagString
XMLTag
readonlyThe XML tag applied to the element. Can also accept: String.
parentApplication
Document
readonlyThe parent of the XMLImportMap (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 XMLImportMap getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the XMLImportMap.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

XMLImportMap XMLImportMaps.nextItem (obj: XMLImportMap)

XMLImportMap XMLImportMaps.previousItem (obj: XMLImportMap)

Return

Array of XMLImportMap XMLImportMap.getElements ()

XMLImportMap XMLImportMaps.[] (index: number)

XMLImportMap XMLImportMaps.add (markupTag: varies, mappedStyle: varies[, withProperties: Object])

XMLImportMap XMLImportMaps.anyItem ()

Array of XMLImportMap XMLImportMaps.everyItem ()

XMLImportMap XMLImportMaps.firstItem ()

XMLImportMap XMLImportMaps.item (index: varies)

Array of XMLImportMap XMLImportMaps.itemByRange (from: varies, to: varies)

XMLImportMap XMLImportMaps.lastItem ()

XMLImportMap XMLImportMaps.middleItem ()

XMLImportMap XMLImportMaps.nextItem (obj: XMLImportMap)

XMLImportMap XMLImportMaps.previousItem (obj: XMLImportMap)

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