Class
Baseline frame grid options. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
BaselineFrameGridOption
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| baselineFrameGridColor | 3 Reals (0 - 255) UIColors |
readonly | The grid line color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. |
| baselineFrameGridIncrement | Measurement Unit (Number or String) (range: 1 - 8640) | readonly | The distance between grid lines. |
| baselineFrameGridRelativeOption | BaselineFrameGridRelativeOption: BaselineFrameGridRelativeOption.TOP_OF_PAGE BaselineFrameGridRelativeOption.TOP_OF_MARGIN BaselineFrameGridRelativeOption.TOP_OF_FRAME BaselineFrameGridRelativeOption.TOP_OF_INSET |
readonly | The location (top of page, top margin, top of frame, or frame inset) on which to base the custom baseline grid. |
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Application Document TextFrame |
readonly | The parent of the BaselineFrameGridOption (a Application, Document or TextFrame). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| startingOffsetForBaselineFrameGrid | Measurement Unit (Number or String) (range: 0 - 8640) | readonly | The amount to offset the baseline grid. |
| useCustomBaselineFrameGrid | bool | readonly | If true, uses a custom baseline frame grid. |
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 BaselineFrameGridOption 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 BaselineFrameGridOption.
Element of
Application.baselineFrameGridOptions
Document.baselineFrameGridOptions
TextFrame.baselineFrameGridOptions
Return
Array of BaselineFrameGridOption BaselineFrameGridOption.getElements ()
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |