K4 InDesign Javascript API Documentation

PreferencesStoryPreference

Story preferences.

Extends

Instance Properties

Name Description Access
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
opticalMarginAlignment bool If true, adjust the position of characters at the edges of the frame to provide a better appearance. read-write
opticalMarginSize Measurement Unit (Number or String)=any The point size used as the basis for calculating optical margin alignment. (Range: 0.1 to 1296) read-write
parent The parent of the StoryPreference (a XmlStory, Application, Document, Story or ObjectStyle). read-only
properties Object A property that allows setting of several properties at the same time. read-write
storyDirection StoryDirectionOptions The direction of the story. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → StoryPreference
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(
)
  → StoryPreference
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 StoryPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.