K4 InDesign Javascript API Documentation

PreferencesTableStyleMappings

A collection of table style mappings.

Instance Properties

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

Methods

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