Packagecom.adobe.indesign
Classpublic class TrackChangesPreference
InheritanceTrackChangesPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  addedBackgroundColorChoice : ChangeBackgroundColorChoices
The background color option for added text.
TrackChangesPreference
  addedTextColorChoice : ChangeTextColorChoices
The color option for added text.
TrackChangesPreference
  backgroundColorForAddedText : Object
The background color for added text, specified as an InCopy UI color.
TrackChangesPreference
  backgroundColorForDeletedText : Object
The background color for deleted text, specified as an InCopy UI color.
TrackChangesPreference
  backgroundColorForMovedText : Object
The background color for moved text, specified as an InCopy UI color.
TrackChangesPreference
  changeBarColor : Object
The change bar color, specified as an InCopy UI color.
TrackChangesPreference
  deletedBackgroundColorChoice : ChangeBackgroundColorChoices
The background color option for deleted text.
TrackChangesPreference
  deletedTextColorChoice : ChangeTextColorChoices
The color option for deleted text.
TrackChangesPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
TrackChangesPreference
  events : Events
[override] [read-only] A collection of events.
TrackChangesPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
TrackChangesPreference
  locationForChangeBar : ChangebarLocations
The change bar location.
TrackChangesPreference
  markingForAddedText : ChangeMarkings
The marking that identifies added text.
TrackChangesPreference
  markingForDeletedText : ChangeMarkings
The marking that identifies deleted text.
TrackChangesPreference
  markingForMovedText : ChangeMarkings
The marking that identifies moved text.
TrackChangesPreference
  movedBackgroundColorChoice : ChangeBackgroundColorChoices
The background color option for moved text.
TrackChangesPreference
  movedTextColorChoice : ChangeTextColorChoices
The color option for moved text.
TrackChangesPreference
  parent : Object
[override] [read-only] The parent of the TrackChangesPreference (a Application).
TrackChangesPreference
  preventDuplicateColor : Boolean
If true, prevent duplicate user color for tracked changes background color.
TrackChangesPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
TrackChangesPreference
  showAddedText : Boolean
If true, displays added text.
TrackChangesPreference
  showChangeBars : Boolean
If true, displays change bars,
TrackChangesPreference
  showDeletedText : Boolean
If true, displays deleted text.
TrackChangesPreference
  showMovedText : Boolean
If true, displays moved text.
TrackChangesPreference
  spellCheckDeletedText : Boolean
If true, includes deleted text when using the Spell Check command.
TrackChangesPreference
  textColorForAddedText : Object
The color for added text, specified as an InCopy UI color.
TrackChangesPreference
  textColorForDeletedText : Object
The color for deleted text, specified as an InCopy UI color.
TrackChangesPreference
  textColorForMovedText : Object
The color for moved text, specified as an InCopy UI color.
TrackChangesPreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerTrackChangesPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
TrackChangesPreference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
TrackChangesPreference
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
  
removeEventListenerTrackChangesPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TrackChangesPreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
TrackChangesPreference
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
addedBackgroundColorChoiceproperty
addedBackgroundColorChoice:ChangeBackgroundColorChoices

The background color option for added text.


Implementation
    public function get addedBackgroundColorChoice():ChangeBackgroundColorChoices
    public function set addedBackgroundColorChoice(value:ChangeBackgroundColorChoices):void
addedTextColorChoiceproperty 
addedTextColorChoice:ChangeTextColorChoices

The color option for added text.


Implementation
    public function get addedTextColorChoice():ChangeTextColorChoices
    public function set addedTextColorChoice(value:ChangeTextColorChoices):void
backgroundColorForAddedTextproperty 
backgroundColorForAddedText:Object

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.


Implementation
    public function get backgroundColorForAddedText():Object
    public function set backgroundColorForAddedText(value:Object):void
backgroundColorForDeletedTextproperty 
backgroundColorForDeletedText:Object

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.


Implementation
    public function get backgroundColorForDeletedText():Object
    public function set backgroundColorForDeletedText(value:Object):void
backgroundColorForMovedTextproperty 
backgroundColorForMovedText:Object

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.


Implementation
    public function get backgroundColorForMovedText():Object
    public function set backgroundColorForMovedText(value:Object):void
changeBarColorproperty 
changeBarColor:Object

The change bar color, specified as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.


Implementation
    public function get changeBarColor():Object
    public function set changeBarColor(value:Object):void
deletedBackgroundColorChoiceproperty 
deletedBackgroundColorChoice:ChangeBackgroundColorChoices

The background color option for deleted text.


Implementation
    public function get deletedBackgroundColorChoice():ChangeBackgroundColorChoices
    public function set deletedBackgroundColorChoice(value:ChangeBackgroundColorChoices):void
deletedTextColorChoiceproperty 
deletedTextColorChoice:ChangeTextColorChoices

The color option for deleted text.


Implementation
    public function get deletedTextColorChoice():ChangeTextColorChoices
    public function set deletedTextColorChoice(value:ChangeTextColorChoices):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
locationForChangeBarproperty 
locationForChangeBar:ChangebarLocations

The change bar location.


Implementation
    public function get locationForChangeBar():ChangebarLocations
    public function set locationForChangeBar(value:ChangebarLocations):void
markingForAddedTextproperty 
markingForAddedText:ChangeMarkings

The marking that identifies added text.


Implementation
    public function get markingForAddedText():ChangeMarkings
    public function set markingForAddedText(value:ChangeMarkings):void
markingForDeletedTextproperty 
markingForDeletedText:ChangeMarkings

The marking that identifies deleted text.


Implementation
    public function get markingForDeletedText():ChangeMarkings
    public function set markingForDeletedText(value:ChangeMarkings):void
markingForMovedTextproperty 
markingForMovedText:ChangeMarkings

The marking that identifies moved text.


Implementation
    public function get markingForMovedText():ChangeMarkings
    public function set markingForMovedText(value:ChangeMarkings):void
movedBackgroundColorChoiceproperty 
movedBackgroundColorChoice:ChangeBackgroundColorChoices

The background color option for moved text.


Implementation
    public function get movedBackgroundColorChoice():ChangeBackgroundColorChoices
    public function set movedBackgroundColorChoice(value:ChangeBackgroundColorChoices):void
movedTextColorChoiceproperty 
movedTextColorChoice:ChangeTextColorChoices

The color option for moved text.


Implementation
    public function get movedTextColorChoice():ChangeTextColorChoices
    public function set movedTextColorChoice(value:ChangeTextColorChoices):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the TrackChangesPreference (a Application).


Implementation
    public function get parent():Object
preventDuplicateColorproperty 
preventDuplicateColor:Boolean

If true, prevent duplicate user color for tracked changes background color.


Implementation
    public function get preventDuplicateColor():Boolean
    public function set preventDuplicateColor(value:Boolean):void
propertiesproperty 
properties:Object[override]

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
showAddedTextproperty 
showAddedText:Boolean

If true, displays added text.


Implementation
    public function get showAddedText():Boolean
    public function set showAddedText(value:Boolean):void
showChangeBarsproperty 
showChangeBars:Boolean

If true, displays change bars,


Implementation
    public function get showChangeBars():Boolean
    public function set showChangeBars(value:Boolean):void
showDeletedTextproperty 
showDeletedText:Boolean

If true, displays deleted text.


Implementation
    public function get showDeletedText():Boolean
    public function set showDeletedText(value:Boolean):void
showMovedTextproperty 
showMovedText:Boolean

If true, displays moved text.


Implementation
    public function get showMovedText():Boolean
    public function set showMovedText(value:Boolean):void
spellCheckDeletedTextproperty 
spellCheckDeletedText:Boolean

If true, includes deleted text when using the Spell Check command.


Implementation
    public function get spellCheckDeletedText():Boolean
    public function set spellCheckDeletedText(value:Boolean):void
textColorForAddedTextproperty 
textColorForAddedText:Object

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.


Implementation
    public function get textColorForAddedText():Object
    public function set textColorForAddedText(value:Object):void
textColorForDeletedTextproperty 
textColorForDeletedText:Object

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.


Implementation
    public function get textColorForDeletedText():Object
    public function set textColorForDeletedText(value:Object):void
textColorForMovedTextproperty 
textColorForMovedText:Object

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.


Implementation
    public function get textColorForMovedText():Object
    public function set textColorForMovedText(value:Object):void
Method Detail
addEventListenerTrackChangesPreference()method
public function addEventListenerTrackChangesPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerTrackChangesPreference()method 
public function removeEventListenerTrackChangesPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String