Class
Grid preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
GridPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| baselineColor | 3 Reals (0 - 255) UIColors |
r/w | The color of the baseline grid, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. |
| baselineDivision | Measurement Unit (Number or String) (range: 1 - 8640) | r/w | The amount of space between baseline grid lines. |
| baselineGridRelativeOption | BaselineGridRelativeOption: BaselineGridRelativeOption.TOP_OF_PAGE_OF_BASELINE_GRID_RELATIVE_OPTION BaselineGridRelativeOption.TOP_OF_MARGIN_OF_BASELINE_GRID_RELATIVE_OPTION |
r/w | The zero point for the baseline grid offset. |
| baselineGridShown | bool | r/w | If true, displays the baseline grid. |
| baselineStart | Measurement Unit (Number or String) (range: 0 - 1000) | r/w | The amount to offset the baseline grid from the zero point. |
| baselineViewThreshold | number (range: 5 - 4000) | r/w | The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000) |
| documentGridShown | bool | r/w | If true, displays the document grid. |
| documentGridSnapto | bool | r/w | If true, an object snaps to the nearest grid line when the object is created, moved, or resized. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| gridColor | 3 Reals (0 - 255) UIColors |
r/w | The color of the document grid, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. |
| gridsInBack | bool | r/w | If true, places grids behind all other objects on the spread. |
| horizontalGridSubdivision | number (range: 1 - 1000) | r/w | The number of rows into which to subdivide the space between horizontal document grid lines. |
| horizontalGridlineDivision | Measurement Unit (Number or String) (range: 0.01 - 1000) | r/w | The amount of space between major horizontal lines in the document grid. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Application Document |
readonly | The parent of the GridPreference (a Application or Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| verticalGridSubdivision | number (range: 1 - 1000) | r/w | The number of columns into which to subdivide the space between vertical document grid lines. |
| verticalGridlineDivision | Measurement Unit (Number or String) (range: 0.01 - 1000) | r/w | The amount of space between major vertical lines in the document 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 GridPreference 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 GridPreference.
Element of
Application.gridPreferences
Document.gridPreferences
Return
Array of GridPreference GridPreference.getElements ()
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |