K4 InDesign Javascript API Documentation

PreferencesLinkedStoryOption

The link options for a linked story.

Extends

Instance Properties

Name Description Access
applyStyleMappings bool If true, style mappings will be applied during linked story creation or update. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the LinkedStoryOption (a Application, Document, Story or XmlStory). read-only
properties Object A property that allows setting of several properties at the same time. read-write
removeForcedLineBreaks bool If true, forced line breaks will be removed during story creation or update. read-write
updateWhileSaving bool If true, the linked story will be updated while saving. read-write
warnOnUpdateOfEditedStory bool If true, a warning will be shown if the update link operation will override local edits. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → LinkedStoryOption
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → LinkedStoryOption
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the LinkedStoryOption.
toSpecifier(
)
  → string
Retrieves the object specifier.