K4 InDesign Javascript API Documentation

PreferencesTrackChangesPreference

Track changes preferences.

Extends

Instance Properties

Name Description Access
addedBackgroundColorChoice ChangeBackgroundColorChoices The background color option for added text. read-write
addedTextColorChoice ChangeTextColorChoices The color option for added text. read-write
backgroundColorForAddedText The background color for added text, specified as an InCopy UI color. Note: Valid only when added background color choice is change background uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write
backgroundColorForDeletedText The background color for deleted text, specified as an InCopy UI color. Note: Valid only when deleted background color choice is change background uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write
backgroundColorForMovedText The background color for moved text, specified as an InCopy UI color. Note: Valid only when moved background color choice is change background uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write
changeBarColor The change bar color, specified as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write
deletedBackgroundColorChoice ChangeBackgroundColorChoices The background color option for deleted text. read-write
deletedTextColorChoice ChangeTextColorChoices The color option for deleted 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
locationForChangeBar ChangebarLocations The change bar location. read-write
markingForAddedText ChangeMarkings The marking that identifies added text. read-write
markingForDeletedText ChangeMarkings The marking that identifies deleted text. read-write
markingForMovedText ChangeMarkings The marking that identifies moved text. read-write
movedBackgroundColorChoice ChangeBackgroundColorChoices The background color option for moved text. read-write
movedTextColorChoice ChangeTextColorChoices The color option for moved text. read-write
parent Application The parent of the TrackChangesPreference (a Application). read-only
preventDuplicateColor bool If true, prevent duplicate user color for tracked changes background color. read-write
properties Object A property that allows setting of several properties at the same time. read-write
showAddedText bool If true, displays added text. read-write
showChangeBars bool If true, displays change bars, read-write
showDeletedText bool If true, displays deleted text. read-write
showMovedText bool If true, displays moved text. read-write
spellCheckDeletedText bool If true, includes deleted text when using the Spell Check command. read-write
textColorForAddedText The color for added text, specified as an InCopy UI color. Note: Valid only when added text color choice is change uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write
textColorForDeletedText The color for deleted text, specified as an InCopy UI color. Note: Valid only when deleted text color choice is change uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write
textColorForMovedText The color for moved text, specified as an InCopy UI color. Note: Valid only when moved text color choice is change uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → TrackChangesPreference
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(
)
  → TrackChangesPreference
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 TrackChangesPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.