TrackChangesPreference

Track changes preferences.

Go to Property Listing | Method Listing

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, ChangeBackgroundColorChoices, ChangeMarkings, ChangeTextColorChoices, ChangebarLocations, EventListeners, Events, InCopyUIColors, Object,

Hierarchy:

Superclass: Preference

Class: TrackChangesPreference

Property Listing

Property	Type	Access	Description
addedBackgroundColorChoice	ChangeBackgroundColorChoices ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR	read/write	The background color option for added text.
addedTextColorChoice	ChangeTextColorChoices ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR	read/write	The color option for added text.
backgroundColorForAddedText	Array of 3 Reals (0 - 255) InCopyUIColors	read/write	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.
backgroundColorForDeletedText	Array of 3 Reals (0 - 255) InCopyUIColors	read/write	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.
backgroundColorForMovedText	Array of 3 Reals (0 - 255) InCopyUIColors	read/write	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.
changeBarColor	Array of 3 Reals (0 - 255) InCopyUIColors	read/write	The change bar color, specified as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
deletedBackgroundColorChoice	ChangeBackgroundColorChoices ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR	read/write	The background color option for deleted text.
deletedTextColorChoice	ChangeTextColorChoices ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR	read/write	The color option for deleted text.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
locationForChangeBar	ChangebarLocations ChangebarLocations.LEFT_ALIGN ChangebarLocations.RIGHT_ALIGN	read/write	The change bar location.
markingForAddedText	ChangeMarkings ChangeMarkings.NONE ChangeMarkings.OUTLINE ChangeMarkings.STRIKETHROUGH ChangeMarkings.UNDERLINE_SINGLE	read/write	The marking that identifies added text.
markingForDeletedText	ChangeMarkings ChangeMarkings.NONE ChangeMarkings.OUTLINE ChangeMarkings.STRIKETHROUGH ChangeMarkings.UNDERLINE_SINGLE	read/write	The marking that identifies deleted text.
markingForMovedText	ChangeMarkings ChangeMarkings.NONE ChangeMarkings.OUTLINE ChangeMarkings.STRIKETHROUGH ChangeMarkings.UNDERLINE_SINGLE	read/write	The marking that identifies moved text.
movedBackgroundColorChoice	ChangeBackgroundColorChoices ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR	read/write	The background color option for moved text.
movedTextColorChoice	ChangeTextColorChoices ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR	read/write	The color option for moved text.
parent	Application	readonly	The parent of the TrackChangesPreference (a Application).
preventDuplicateColor	Boolean	read/write	If true, prevent duplicate user color for tracked changes background color.
properties	Object	read/write	A property that allows setting of several properties at the same time.
showAddedText	Boolean	read/write	If true, displays added text.
showChangeBars	Boolean	read/write	If true, displays change bars,
showDeletedText	Boolean	read/write	If true, displays deleted text.
showMovedText	Boolean	read/write	If true, displays moved text.
spellCheckDeletedText	Boolean	read/write	If true, includes deleted text when using the Spell Check command.
textColorForAddedText	Array of 3 Reals (0 - 255) InCopyUIColors	read/write	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.
textColorForDeletedText	Array of 3 Reals (0 - 255) InCopyUIColors	read/write	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.
textColorForMovedText	Array of 3 Reals (0 - 255) InCopyUIColors	read/write	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.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

TrackChangesPreference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)