InDesign Server2025
API 20.5.0.49
Object

StoryPreference

Story preferences.

Preference StoryPreference
Hierarchy

Application | Document | ObjectStyle | Story | XmlStory

StoryPreference

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
FrameTypes
read/write The type of text frame.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Boolean read/write If true, adjust the position of characters at the edges of the frame to provide a better appearance.
Number | String unit read/write The point size used as the basis for calculating optical margin alignment. (Range: 0.1 to 1296)
Application | Document | Story | ObjectStyle | XmlStory readonly The parent of the StoryPreference (a XmlStory, Application, Document, Story or ObjectStyle).
Object read/write A property that allows setting of several properties at the same time.
StoryDirectionOptions
read/write The direction of the story.
StoryHorizontalOrVertical
read/write The orientation of the text in the story.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
StoryPreference[]

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

Boolean

Removes the event listener.

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

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

String

Retrieves the object specifier.

Object of 8

Properties elsewhere that hold a StoryPreference.

Return 1

Methods that return a StoryPreference.