Adobe InCopy CS5 (7.0) Object Model JS: XMLExportMaps

InCopy CS5

Class

XMLExportMaps

 A collection of XML export maps.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

XMLExportMap [] (index: number)
Returns the XMLExportMap with the specified index.

ParameterTypeDescription
indexnumberThe index.

XMLExportMap add (mappedStyle: varies, markupTag: varies[, withProperties: Object])
Create a new mapping

ParameterTypeDescription
mappedStyleCellStyle
CharacterStyle
ParagraphStyle
String
TableStyle
The mapped style. Can accept: ParagraphStyle, CharacterStyle, TableStyle, CellStyle or String.
markupTagString
XMLTag
The tag to map. Can accept: XMLTag or String.
withPropertiesObjectInitial values for properties of the new XMLExportMap (Optional)

XMLExportMap anyItem ()
Returns any XMLExportMap in the collection.

number count ()
Displays the number of elements in the XMLExportMap.

Array of XMLExportMap everyItem ()
Returns every XMLExportMap in the collection.

XMLExportMap firstItem ()
Returns the first XMLExportMap in the collection.

XMLExportMap item (index: varies)
Returns the XMLExportMap with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Array of XMLExportMap itemByRange (from: varies, to: varies)
Returns the XMLExportMaps within the specified range.

ParameterTypeDescription
fromLong Integer
String
XMLExportMap
The XMLExportMap, index, or name at the beginning of the range. Can accept: XMLExportMap, Long Integer or String.
toLong Integer
String
XMLExportMap
The XMLExportMap, index, or name at the end of the range. Can accept: XMLExportMap, Long Integer or String.

XMLExportMap lastItem ()
Returns the last XMLExportMap in the collection.

XMLExportMap middleItem ()
Returns the middle XMLExportMap in the collection.

XMLExportMap nextItem (obj: XMLExportMap)
Returns the XMLExportMap whose index follows the specified XMLExportMap in the collection.

ParameterTypeDescription
objXMLExportMapThe XMLExportMap whose index comes before the desired XMLExportMap.

XMLExportMap previousItem (obj: XMLExportMap)
Returns the XMLExportMap with the index previous to the specified index.

ParameterTypeDescription
objXMLExportMapThe index of the XMLExportMap that follows the desired XMLExportMap.

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

Element of

Application.xmlExportMaps

Document.xmlExportMaps

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