K4 InDesign Javascript API Documentation

PreferencesMatchCharacterStylePreference

The preferences for a running header/footer (match character style) variable.

Extends

Instance Properties

Name Description Access
appliedCharacterStyle CharacterStyle The character style applied to the text. Can also accept: String. read-write
changeCase ChangeCaseOptions The case of the matched text. read-write
deleteEndPunctuation bool If true, deletes end punctuation from the matched text. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent TextVariable The parent of the MatchCharacterStylePreference (a TextVariable). read-only
properties Object A property that allows setting of several properties at the same time. read-write
searchStrategy SearchStrategies The starting point and direction in which the search will be conducted. read-write
textAfter string The text that follows the value of the variable. (Limit: 128 characters) read-write
textBefore string The text that precedes the value of the variable. (Limit: 128 characters) read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → MatchCharacterStylePreference
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(
)
  → MatchCharacterStylePreference
Resolves the object specifier, creating an array of object references.
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 MatchCharacterStylePreference.
toSpecifier(
)
  → string
Retrieves the object specifier.