LinkedStoryOption
The link options for a linked story.
Go to Property Listing | Method Listing
Methods:
addEventListener, getElements, removeEventListener, toSource, toSpecifier
Objects:
Hierarchy:
Superclass: Preference
Class: LinkedStoryOption
Property Listing
Property |
Type |
Access |
Description |
---|---|---|---|
read/write |
If true, style mappings will be applied during linked story creation or update. |
||
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
readonly |
The parent of the LinkedStoryOption (a Application, Document, Story or XmlStory). |
||
read/write |
A property that allows setting of several properties at the same time. |
||
read/write |
If true, forced line breaks will be removed during story creation or update. |
||
read/write |
If true, the linked story will be updated while saving. |
||
read/write |
If true, a warning will be shown if the update link operation will override local edits. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
LinkedStoryOption getElements ()
Resolves the object specifier, creating an array of object references.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
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 LinkedStoryOption.
String toSpecifier ()
Retrieves the object specifier.
Object of
Application.linkedStoryOptions
Document.linkedStoryOptions
Story.linkedStoryOptions
XmlStory.linkedStoryOptions
Event.parent
EventListener.parent
MutationEvent.parent