Class
The link options for a linked story. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
LinkedStoryOption
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | ApplicationDocument Story XmlStory |
readonly | The parent of the LinkedStoryOption (a Application, Document, Story or XmlStory). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| removeForcedLineBreaks | bool | r/w | If true, forced line breaks will be removed during story creation or update. |
| updateWhileSaving | bool | r/w | If true, the linked story will be updated while saving. |
| warnOnUpdateOfEditedStory | bool | r/w | If true, a warning will be shown if the update link operation will override local edits. |
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 LinkedStoryOption 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 LinkedStoryOption.
Element of
Application.linkedStoryOptions
Document.linkedStoryOptions
Story.linkedStoryOptions
XmlStory.linkedStoryOptions
Return
Array of LinkedStoryOption LinkedStoryOption.getElements ()
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |