K4 InDesign Javascript API Documentation

PreferencesCellStyleMappings

A collection of cell style mappings.

Instance Properties

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

Methods

add(
sourceStyleName, destinationStyleName, mappingRuleType ​[, withProperties])
  → CellStyleMapping
anyItem(
)
  → CellStyleMapping
count(
)
  → number
everyItem(
)
  → CellStyleMapping
firstItem(
)
  → CellStyleMapping
item(
index)
  → CellStyleMapping
itemByRange(
from, to)
  → CellStyleMapping
lastItem(
)
  → CellStyleMapping
middleItem(
)
  → CellStyleMapping
nextItem(
obj)
  → CellStyleMapping
previousItem(
obj)
  → CellStyleMapping
toSource(
)
  → string
add(
sourceStyleName, destinationStyleName, mappingRuleType ​[, withProperties])
  → CellStyleMapping
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 CellStyleMapping (Optional)
anyItem(
)
  → CellStyleMapping
Returns any CellStyleMapping in the collection.
count(
)
  → number
Displays the number of elements in the CellStyleMapping.
everyItem(
)
  → CellStyleMapping
Returns every CellStyleMapping in the collection.
firstItem(
)
  → CellStyleMapping
Returns the first CellStyleMapping in the collection.
item(
index)
  → CellStyleMapping
Returns the CellStyleMapping with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → CellStyleMapping
Returns the CellStyleMappings within the specified range.
from The CellStyleMapping, index, or name at the beginning of the range. Can accept: CellStyleMapping, Long Integer or String.
to The CellStyleMapping, index, or name at the end of the range. Can accept: CellStyleMapping, Long Integer or String.
lastItem(
)
  → CellStyleMapping
Returns the last CellStyleMapping in the collection.
middleItem(
)
  → CellStyleMapping
Returns the middle CellStyleMapping in the collection.
nextItem(
obj)
  → CellStyleMapping
Returns the CellStyleMapping whose index follows the specified CellStyleMapping in the collection.
obj CellStyleMapping The CellStyleMapping whose index comes before the desired CellStyleMapping.
previousItem(
obj)
  → CellStyleMapping
Returns the CellStyleMapping with the index previous to the specified index.
obj CellStyleMapping The index of the CellStyleMapping that follows the desired CellStyleMapping.
toSource(
)
  → string
Generates a string which, if executed, will return the CellStyleMapping.