LinkedStoryOption

The link options for a linked story.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Object,

Hierarchy:

Superclass: Preference

Class: LinkedStoryOption

Property Listing

Property

Type

Access

Description

applyStyleMappings

Boolean

read/write

If true, style mappings will be applied during linked story creation or update.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Document

Story

Application

XmlStory

readonly

The parent of the LinkedStoryOption (a Application, Document, Story or XmlStory).

properties

Object

read/write

A property that allows setting of several properties at the same time.

removeForcedLineBreaks

Boolean

read/write

If true, forced line breaks will be removed during story creation or update.

updateWhileSaving

Boolean

read/write

If true, the linked story will be updated while saving.

warnOnUpdateOfEditedStory

Boolean

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

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

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

Return

LinkedStoryOption.getElements()