Change
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| changeType | ChangeTypes: ChangeTypes.INSERTED_TEXT ChangeTypes.DELETED_TEXT ChangeTypes.MOVED_TEXT |
readonly | The type of tracked change. Note: Valid only when track changes is true. |
| characters | Characters | readonly | A collection of characters. |
| date | Date | readonly | The date on which the tracked change was made. Note: Valid only when track changes is true. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| index | number | readonly | The index of the Change within its containing object. |
| insertionPoints | InsertionPoints | readonly | A collection of insertion points. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| lines | Lines | readonly | A collection of lines. |
| paragraphs | Paragraphs | readonly | A collection of paragraphs. |
| parent | Cell Story XmlStory |
readonly | The parent of the Change (a Story, XmlStory or Cell). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| storyOffset | InsertionPoint | readonly | The location of the first insertion point in the object (relative to the beginning of the story). |
| textColumns | TextColumns | readonly | A collection of text columns. |
| textStyleRanges | TextStyleRanges | readonly | A collection of text style ranges. |
| textVariableInstances | TextVariableInstances | readonly | A collection of text variable instances. |
| texts | Texts | readonly | A collection of text objects. |
| userName | string | readonly | The user who made the change. Note: Valid only when track changes is true. |
| words | Words | readonly | A collection of words. |
Methods
Instances
void accept ()
Accepts the tracked change. Note: Valid only when track changes is true.
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 Change getElements ()
Resolves the object specifier, creating an array of object references.
void reject ()
Rejects the tracked change. Note: Valid only when track changes is true.
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 Change.
Element of
Character.parent
InsertionPoint.parent
Line.parent
Paragraph.parent
Text.parent
TextColumn.parent
TextStyleRange.parent
TextVariableInstance.parent
Word.parent
Used in:
Change Changes.nextItem (obj: Change)
Change Changes.previousItem (obj: Change)
Return
Array of Change Change.getElements ()
Change Changes.[] (index: number)
Change Changes.anyItem ()
Array of Change Changes.everyItem ()
Change Changes.firstItem ()
Change Changes.item (index: varies)
Array of Change Changes.itemByRange (from: varies, to: varies)
Change Changes.lastItem ()
Change Changes.middleItem ()
Change Changes.nextItem (obj: Change)
Change Changes.previousItem (obj: Change)
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |