Class

Change

 A tracked change made to a story.

QuickLinks

accept, addEventListener, getElements, reject, removeEventListener, toSource, toSpecifier

Hierarchy

Cell | Story | XmlStory
Change
Character | Event | EventListener | InsertionPoint | Line | MutationEvent | Paragraph | Text | TextColumn | TextStyleRange | TextVariableInstance | Word

Properties

PropertyTypeAccessDescription
changeTypeChangeTypes:
ChangeTypes.INSERTED_TEXT
ChangeTypes.DELETED_TEXT
ChangeTypes.MOVED_TEXT
readonlyThe type of tracked change. Note: Valid only when track changes is true.
charactersCharacters readonlyA collection of characters.
dateDate readonlyThe date on which the tracked change was made. Note: Valid only when track changes is true.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the Change within its containing object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
linesLines readonlyA collection of lines.
paragraphsParagraphs readonlyA collection of paragraphs.
parentCell
Story
XmlStory
readonlyThe parent of the Change (a Story, XmlStory or Cell).
propertiesObject r/wA property that allows setting of several properties at the same time.
storyOffsetInsertionPoint readonlyThe location of the first insertion point in the object (relative to the beginning of the story).
textColumnsTextColumns readonlyA collection of text columns.
textStyleRangesTextStyleRanges readonlyA collection of text style ranges.
textVariableInstancesTextVariableInstances readonlyA collection of text variable instances.
textsTexts readonlyA collection of text objects.
userNamestring readonlyThe user who made the change. Note: Valid only when track changes is true.
wordsWords readonlyA 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the Change.

string toSpecifier ()
Retrieves the object specifier.

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.3hContents :: Index