K4 InDesign Javascript API Documentation

PreferencesCharStyleMappings

A collection of char style mappings.

Instance Properties

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

Methods

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