GridPreference

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

BaselineGridRelativeOption, Boolean, EventListeners, Events, Number, Object, String, UIColors,

Hierarchy:

Class: GridPreference

Property Listing

Property	Type	Access	Description
baselineColor	Array of 3 Reals (0 - 255) UIColors	read/write	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	Number String	read/write	The amount of space between baseline grid lines.
baselineGridRelativeOption	BaselineGridRelativeOption BaselineGridRelativeOption.TOP_OF_MARGIN_OF_BASELINE_GRID_RELATIVE_OPTION BaselineGridRelativeOption.TOP_OF_PAGE_OF_BASELINE_GRID_RELATIVE_OPTION	read/write	The zero point for the baseline grid offset.
baselineGridShown	Boolean	read/write	If true, displays the baseline grid.
baselineStart	Number String	read/write	The amount to offset the baseline grid from the zero point.
baselineViewThreshold	Number (range 5 - 4000)	read/write	The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)
documentGridShown	Boolean	read/write	If true, displays the document grid.
documentGridSnapto	Boolean	read/write	If true, an object snaps to the nearest grid line when the object is created, moved, or resized.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
gridColor	Array of 3 Reals (0 - 255) UIColors	read/write	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	Boolean	read/write	If true, places grids behind all other objects on the spread.
horizontalGridSubdivision	Number (range 1 - 1000)	read/write	The number of rows into which to subdivide the space between horizontal document grid lines.
horizontalGridlineDivision	Number String	read/write	The amount of space between major horizontal lines in the document grid.
isValid	Boolean	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	read/write	A property that allows setting of several properties at the same time.
verticalGridSubdivision	Number (range 1 - 1000)	read/write	The number of columns into which to subdivide the space between vertical document grid lines.
verticalGridlineDivision	Number String	read/write	The amount of space between major vertical lines in the document grid.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

GridPreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
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. (Optional) (default: false)