A tracked change made to a story.
Go to Property Listing | Method Listing
accept, reject, toSource, getElements, toSpecifier, addEventListener, removeEventListener
Boolean, Cell, ChangeTypes, Characters, Date, EventListeners, Events, InsertionPoint, InsertionPoints, Lines, Number, Object, Paragraphs, Story, String, TextColumns, TextStyleRanges, TextVariableInstances, Texts, Words, XmlStory,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
changeType |
ChangeTypes.INSERTED_TEXT ChangeTypes.DELETED_TEXT ChangeTypes.MOVED_TEXT |
readonly |
The type of tracked change. Note: Valid only when track changes is true. |
|
characters |
readonly |
A collection of characters. |
|
|
date |
readonly |
The date on which the tracked change was made. Note: Valid only when track changes is true. |
|
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
index |
readonly |
The index of the Change within its containing object. |
|
|
insertionPoints |
readonly |
A collection of insertion points. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
lines |
readonly |
A collection of lines. |
|
|
paragraphs |
readonly |
A collection of paragraphs. |
|
|
parent |
readonly |
The parent of the Change (a Story, XmlStory or Cell). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
storyOffset |
readonly |
The location of the first insertion point in the object (relative to the beginning of the story). |
|
|
textColumns |
readonly |
A collection of text columns. |
|
|
textStyleRanges |
readonly |
A collection of text style ranges. |
|
|
textVariableInstances |
readonly |
A collection of text variable instances. |
|
|
texts |
readonly |
A collection of text objects. |
|
|
userName |
readonly |
The user who made the change. Note: Valid only when track changes is true. |
|
|
words |
readonly |
A collection of words. |
undefined accept ()
Accepts the tracked change. Note: Valid only when track changes is true.
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
Change getElements ()
Resolves the object specifier, creating an array of object references.
undefined reject ()
Rejects the tracked change. Note: Valid only when track changes is true.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the Change.
String toSpecifier ()
Retrieves the object specifier.
Character.parent
Event.parent
EventListener.parent
InsertionPoint.parent
Line.parent
MutationEvent.parent
Paragraph.parent
Text.parent
TextColumn.parent
TextStyleRange.parent
TextVariableInstance.parent
Word.parent