Class
Track changes preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
TrackChangesPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| addedBackgroundColorChoice | ChangeBackgroundColorChoices: ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR |
r/w | The background color option for added text. |
| addedTextColorChoice | ChangeTextColorChoices: ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR |
r/w | The color option for added text. |
| backgroundColorForAddedText | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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 | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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 | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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 | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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_GALLEY_BACKGROUND_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR |
r/w | The background color option for deleted text. |
| deletedTextColorChoice | ChangeTextColorChoices: ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR |
r/w | The color option for deleted text. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| locationForChangeBar | ChangebarLocations: ChangebarLocations.LEFT_ALIGN ChangebarLocations.RIGHT_ALIGN |
r/w | The change bar location. |
| markingForAddedText | ChangeMarkings: ChangeMarkings.NONE ChangeMarkings.STRIKETHROUGH ChangeMarkings.UNDERLINE_SINGLE ChangeMarkings.OUTLINE |
r/w | The marking that identifies added text. |
| markingForDeletedText | ChangeMarkings: ChangeMarkings.NONE ChangeMarkings.STRIKETHROUGH ChangeMarkings.UNDERLINE_SINGLE ChangeMarkings.OUTLINE |
r/w | The marking that identifies deleted text. |
| markingForMovedText | ChangeMarkings: ChangeMarkings.NONE ChangeMarkings.STRIKETHROUGH ChangeMarkings.UNDERLINE_SINGLE ChangeMarkings.OUTLINE |
r/w | The marking that identifies moved text. |
| movedBackgroundColorChoice | ChangeBackgroundColorChoices: ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_USER_COLOR ChangeBackgroundColorChoices.CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR |
r/w | The background color option for moved text. |
| movedTextColorChoice | ChangeTextColorChoices: ChangeTextColorChoices.CHANGE_USES_GALLEY_TEXT_COLOR ChangeTextColorChoices.CHANGE_USES_CHANGE_PREF_COLOR |
r/w | The color option for moved text. |
| parent | Application | readonly | The parent of the TrackChangesPreference (a Application). |
| preventDuplicateColor | bool | r/w | If true, prevent duplicate user color for tracked changes background color. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| showAddedText | bool | r/w | If true, displays added text. |
| showChangeBars | bool | r/w | If true, displays change bars, |
| showDeletedText | bool | r/w | If true, displays deleted text. |
| showMovedText | bool | r/w | If true, displays moved text. |
| spellCheckDeletedText | bool | r/w | If true, includes deleted text when using the Spell Check command. |
| textColorForAddedText | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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 | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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 | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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, 20-Jun-2010 v3.0.3d | Contents :: Index |