Adobe InDesign CS6 Server (8.0) Object Model JS: LinkedStoryOption

InDesign Server CS6

Class

LinkedStoryOption

 The link options for a linked story. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document | Story | XmlStory
Preference
LinkedStoryOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
applyStyleMappingsbool r/wIf true, style mappings will be applied during linked story creation or update.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplicationDocument
Story
XmlStory
readonlyThe parent of the LinkedStoryOption (a Application, Document, Story or XmlStory).
propertiesObject r/wA property that allows setting of several properties at the same time.
removeForcedLineBreaksbool r/wIf true, forced line breaks will be removed during story creation or update.
updateWhileSavingbool r/wIf true, the linked story will be updated while saving.
warnOnUpdateOfEditedStorybool r/wIf 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.

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 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.

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 LinkedStoryOption.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.linkedStoryOptions

Document.linkedStoryOptions

Story.linkedStoryOptions

XmlStory.linkedStoryOptions

Return

Array of LinkedStoryOption LinkedStoryOption.getElements ()

Jongware, 28-Apr-2012 v3.0.3iContents :: Index