Adobe InDesign CS6 Server (8.0) Object Model JS: ParaStyleMappings

InDesign Server CS6

Class

ParaStyleMappings

 A collection of para style mappings.

See also ParaStyleMapping.

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

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

ParameterTypeDescription
indexnumberThe index.

ParaStyleMapping add (sourceStyleName: string, destinationStyleName: string, mappingRuleType: MapType[, withProperties: Object])
Adds a style mapping.

ParameterTypeDescription
sourceStyleNamestringThe source style name.
destinationStyleNamestringThe destination style name.
mappingRuleTypeMapType:
MapType.STYLE_MAPPING_RULE
MapType.GROUP_MAPPING_RULE
MapType.STYLE_TO_GROUP_MAPPING_RULE
MapType.GROUP_TO_STYLE_MAPPING_RULE
The mapping type
withPropertiesObjectInitial values for properties of the new ParaStyleMapping (Optional)

ParaStyleMapping anyItem ()
Returns any ParaStyleMapping in the collection.

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

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

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

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

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

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

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

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

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

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

ParameterTypeDescription
objParaStyleMappingThe ParaStyleMapping whose index comes before the desired ParaStyleMapping.

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

ParameterTypeDescription
objParaStyleMappingThe index of the ParaStyleMapping that follows the desired ParaStyleMapping.

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

Element of

Application.paraStyleMappings

Document.paraStyleMappings

Story.paraStyleMappings

XmlStory.paraStyleMappings

Jongware, 28-Apr-2012 v3.0.3iContents :: Index