K4 InDesign Javascript API Documentation

TextNestedStyle

A nested style.

Instance Properties

Name Description Access
appliedCharacterStyle CharacterStyle The character style applied to the text. Can also accept: String. read-write
delimiter The delimiting expression that indicates how deeply into the paragraph the nested style is applied. Can return: String or NestedStyleDelimiters enumerator. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
inclusive bool If true, the nested style is applied through the last delimiter. If false, the nested style is applied up to the last delimiter. read-write
index number The index of the NestedStyle within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the NestedStyle (a TextDefault, Paragraph, ParagraphStyle, Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, Story or XmlStory). read-only
properties Object A property that allows setting of several properties at the same time. read-write
repetition number The number instances of the specified delimiter up to which, or through which, to apply the nested style. read-write

Methods

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