Edit in GitHubLog an issue

LinkedStoryOption

The link options for a linked story.

Instance

Read Only

Boolean isValid

Returns true if the object specifier resolves to valid objects.


Read Only

Mixed parent

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


Read Only

Events events

A collection of events.


Read Only

EventListeners eventListeners

A collection of event listeners.


Boolean updateWhileSaving

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


Boolean warnOnUpdateOfEditedStory

If true, a warning will be shown if the update link operation will override local edits.


Boolean removeForcedLineBreaks

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


Boolean applyStyleMappings

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


Object properties

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

Methods

String toSource()

Generates a string which, if executed, will return the LinkedStoryOption.


LinkedStoryOption getElements()

Resolves the object specifier, creating an array of object references.


String toSpecifier()

Retrieves the object specifier.


EventListener addEventListener( String eventType, Mixed handler, Boolean captures )

Adds an event listener.

Parameters

TypeNameDescription
String
eventType
The event type.
Mixed
handler
The event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)

Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )

Removes the event listener.

Parameters

TypeNameDescription
String
eventType
The registered event type.
Mixed
handler
The registered event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)
Was this helpful?
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2023 Adobe. All rights reserved.