Adobe InDesign CS5 Server (7.0) Object Model JS: TrackChangesPreference

InDesign Server CS5

Class

TrackChangesPreference

 Track changes preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
TrackChangesPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
addedBackgroundColorChoiceChangeBackgroundColorChoices:
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR
r/wThe background color option for added text.
addedTextColorChoiceChangeTextColorChoices:
ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR
ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR
r/wThe color option for added text.
backgroundColorForAddedText3 Reals (0 - 255)
InCopyUIColors
r/wThe 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.
backgroundColorForDeletedText3 Reals (0 - 255)
InCopyUIColors
r/wThe 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.
backgroundColorForMovedText3 Reals (0 - 255)
InCopyUIColors
r/wThe 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.
changeBarColor3 Reals (0 - 255)
InCopyUIColors
r/wThe change bar color, specified as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
deletedBackgroundColorChoiceChangeBackgroundColorChoices:
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR
r/wThe background color option for deleted text.
deletedTextColorChoiceChangeTextColorChoices:
ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR
ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR
r/wThe color option for deleted text.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
locationForChangeBarChangebarLocations:
ChangebarLocations.LEFT_ALIGN
ChangebarLocations.RIGHT_ALIGN
r/wThe change bar location.
markingForAddedTextChangeMarkings:
ChangeMarkings.NONE
ChangeMarkings.STRIKETHROUGH
ChangeMarkings.UNDERLINE_SINGLE
ChangeMarkings.OUTLINE
r/wThe marking that identifies added text.
markingForDeletedTextChangeMarkings:
ChangeMarkings.NONE
ChangeMarkings.STRIKETHROUGH
ChangeMarkings.UNDERLINE_SINGLE
ChangeMarkings.OUTLINE
r/wThe marking that identifies deleted text.
markingForMovedTextChangeMarkings:
ChangeMarkings.NONE
ChangeMarkings.STRIKETHROUGH
ChangeMarkings.UNDERLINE_SINGLE
ChangeMarkings.OUTLINE
r/wThe marking that identifies moved text.
movedBackgroundColorChoiceChangeBackgroundColorChoices:
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR
ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR
r/wThe background color option for moved text.
movedTextColorChoiceChangeTextColorChoices:
ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR
ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR
r/wThe color option for moved text.
parentApplication readonlyThe parent of the TrackChangesPreference (a Application).
preventDuplicateColorbool r/wIf true, prevent duplicate user color for tracked changes background color.
propertiesObject r/wA property that allows setting of several properties at the same time.
showAddedTextbool r/wIf true, displays added text.
showChangeBarsbool r/wIf true, displays change bars,
showDeletedTextbool r/wIf true, displays deleted text.
showMovedTextbool r/wIf true, displays moved text.
spellCheckDeletedTextbool r/wIf true, includes deleted text when using the Spell Check command.
textColorForAddedText3 Reals (0 - 255)
InCopyUIColors
r/wThe 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.
textColorForDeletedText3 Reals (0 - 255)
InCopyUIColors
r/wThe 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.
textColorForMovedText3 Reals (0 - 255)
InCopyUIColors
r/wThe 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.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of TrackChangesPreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the TrackChangesPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.trackChangesPreferences

Return

Array of TrackChangesPreference TrackChangesPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index