K4 InDesign Javascript API Documentation

PreferencesParaStyleMappings

A collection of para style mappings.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
sourceStyleName, destinationStyleName, mappingRuleType ​[, withProperties])
  → ParaStyleMapping
anyItem(
)
  → ParaStyleMapping
count(
)
  → number
everyItem(
)
  → ParaStyleMapping
firstItem(
)
  → ParaStyleMapping
item(
index)
  → ParaStyleMapping
itemByRange(
from, to)
  → ParaStyleMapping
lastItem(
)
  → ParaStyleMapping
middleItem(
)
  → ParaStyleMapping
nextItem(
obj)
  → ParaStyleMapping
previousItem(
obj)
  → ParaStyleMapping
toSource(
)
  → string
add(
sourceStyleName, destinationStyleName, mappingRuleType ​[, withProperties])
  → ParaStyleMapping
Adds a style mapping.
sourceStyleName string The source style name.
destinationStyleName string The destination style name.
mappingRuleType MapType The mapping type
withProperties Object Initial values for properties of the new ParaStyleMapping (Optional)
anyItem(
)
  → ParaStyleMapping
Returns any ParaStyleMapping in the collection.
count(
)
  → number
Displays the number of elements in the ParaStyleMapping.
everyItem(
)
  → ParaStyleMapping
Returns every ParaStyleMapping in the collection.
firstItem(
)
  → ParaStyleMapping
Returns the first ParaStyleMapping in the collection.
item(
index)
  → ParaStyleMapping
Returns the ParaStyleMapping with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → ParaStyleMapping
Returns the ParaStyleMappings within the specified range.
from The ParaStyleMapping, index, or name at the beginning of the range. Can accept: ParaStyleMapping, Long Integer or String.
to The ParaStyleMapping, index, or name at the end of the range. Can accept: ParaStyleMapping, Long Integer or String.
lastItem(
)
  → ParaStyleMapping
Returns the last ParaStyleMapping in the collection.
middleItem(
)
  → ParaStyleMapping
Returns the middle ParaStyleMapping in the collection.
nextItem(
obj)
  → ParaStyleMapping
Returns the ParaStyleMapping whose index follows the specified ParaStyleMapping in the collection.
obj ParaStyleMapping The ParaStyleMapping whose index comes before the desired ParaStyleMapping.
previousItem(
obj)
  → ParaStyleMapping
Returns the ParaStyleMapping with the index previous to the specified index.
obj ParaStyleMapping The index of the ParaStyleMapping that follows the desired ParaStyleMapping.
toSource(
)
  → string
Generates a string which, if executed, will return the ParaStyleMapping.