Adobe InDesign CS5 Server (7.0) Object Model JS: StoryPreference

InDesign Server CS5

Class

StoryPreference

 Story preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document | ObjectStyle | Story | XmlStory
Preference
StoryPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
frameTypeFrameTypes:
FrameTypes.TEXT_FRAME_TYPE
FrameTypes.FRAME_GRID_TYPE
FrameTypes.UNKNOWN
r/wThe type of text frame.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
opticalMarginAlignmentbool r/wIf true, adjust the position of characters at the edges of the frame to provide a better appearance.
opticalMarginSizeMeasurement Unit (Number or String) (range: 0.1 - 1296) r/wThe point size used as the basis for calculating optical margin alignment. (Range: 0.1 to 1296)
parentApplication
Document
ObjectStyle
Story
XmlStory
readonlyThe parent of the StoryPreference (a XmlStory, Application, Document, Story or ObjectStyle).
propertiesObject r/wA property that allows setting of several properties at the same time.
storyDirectionStoryDirectionOptions:
StoryDirectionOptions.LEFT_TO_RIGHT_DIRECTION
StoryDirectionOptions.RIGHT_TO_LEFT_DIRECTION
StoryDirectionOptions.UNKNOWN_DIRECTION
r/wThe direction of the story.
storyOrientationStoryHorizontalOrVertical:
StoryHorizontalOrVertical.HORIZONTAL
StoryHorizontalOrVertical.VERTICAL
StoryHorizontalOrVertical.UNKNOWN
r/wThe orientation of the text in the story.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.storyPreferences

Document.storyPreferences

ObjectStyle.storyPreferences

Story.storyPreferences

XmlStory.storyPreferences

Return

Array of StoryPreference StoryPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index