K4 InDesign Javascript API Documentation

TextChange

A tracked change made to a story.

Instance Properties

Name Description Access
changeType ChangeTypes The type of tracked change. Note: Valid only when track changes is true. read-only
characters Characters A collection of characters. read-only
date Date The date on which the tracked change was made. Note: Valid only when track changes is true. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the Change within its containing object. read-only
insertionPoints InsertionPoints A collection of insertion points. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
lines Lines A collection of lines. read-only
paragraphs Paragraphs A collection of paragraphs. read-only
parent The parent of the Change (a Story, XmlStory or Cell). read-only
properties Object A property that allows setting of several properties at the same time. read-write
storyOffset InsertionPoint The location of the first insertion point in the object (relative to the beginning of the story). read-only
textColumns TextColumns A collection of text columns. read-only
textStyleRanges TextStyleRanges A collection of text style ranges. read-only
textVariableInstances TextVariableInstances A collection of text variable instances. read-only
texts Texts A collection of text objects. read-only
userName string The user who made the change. Note: Valid only when track changes is true. read-only
words Words A collection of words. read-only

Methods

accept(
)
addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → Change
reject(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
accept(
)
Accepts the tracked change. Note: Valid only when track changes is true.
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(
)
  → Change
Resolves the object specifier, creating an array of object references.
reject(
)
Rejects the tracked change. Note: Valid only when track changes is true.
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 Change.
toSpecifier(
)
  → string
Retrieves the object specifier.