Class
Story preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
StoryPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| frameType | FrameTypes: FrameTypes.TEXT_FRAME_TYPE FrameTypes.FRAME_GRID_TYPE FrameTypes.UNKNOWN |
r/w | The type of text frame. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| opticalMarginAlignment | bool | r/w | If true, adjust the position of characters at the edges of the frame to provide a better appearance. |
| opticalMarginSize | Measurement Unit (Number or String) (range: 0.1 - 1296) | r/w | The point size used as the basis for calculating optical margin alignment. (Range: 0.1 to 1296) |
| parent | Application Document ObjectStyle Story XmlStory |
readonly | The parent of the StoryPreference (a XmlStory, Application, Document, Story or ObjectStyle). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| storyDirection | StoryDirectionOptions: StoryDirectionOptions.LEFT_TO_RIGHT_DIRECTION StoryDirectionOptions.RIGHT_TO_LEFT_DIRECTION StoryDirectionOptions.UNKNOWN_DIRECTION |
r/w | The direction of the story. |
| storyOrientation | StoryHorizontalOrVertical: StoryHorizontalOrVertical.HORIZONTAL StoryHorizontalOrVertical.VERTICAL StoryHorizontalOrVertical.UNKNOWN |
r/w | The orientation of the text in the story. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the StoryPreference.
Element of
Application.storyPreferences
Document.storyPreferences
ObjectStyle.storyPreferences
Story.storyPreferences
XmlStory.storyPreferences
Return
Array of StoryPreference StoryPreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |