K4 InDesign Javascript API Documentation

PreferencesCharStyleMapping

A char style mapping.

Instance Properties

Name Description Access
destinationStyleName string The destination style name property. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the CharStyleMapping within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
mappingRuleType MapType The type of the mapping rule. read-write
parent The parent of the CharStyleMapping (a Application, Document, Story or XmlStory). read-only
properties Object A property that allows setting of several properties at the same time. read-write
sourceStyleName string The source style name property. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → CharStyleMapping
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → CharStyleMapping
Resolves the object specifier, creating an array of object references.
remove(
)
deletes a style mapping.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the CharStyleMapping.
toSpecifier(
)
  → string
Retrieves the object specifier.