InDesign2026
API 21.5.1.73
Object

GridPreference

Grid preferences.

Preference GridPreference
Hierarchy

Application | Document

GridPreference

Properties

NameType AccessDescription
3 Reals (0 - 255)[] | UIColors[]
+25 more
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.
Number | String unit read/write The amount of space between baseline grid lines.
BaselineGridRelativeOption
read/write The zero point for the baseline grid offset.
Boolean read/write If true, displays the baseline grid.
Number | String unit read/write The amount to offset the baseline grid from the zero point.
Number 5–4000 read/write The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)
Boolean read/write If true, displays the document grid.
Boolean read/write If true, an object snaps to the nearest grid line when the object is created, moved, or resized.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
3 Reals (0 - 255)[] | UIColors[]
+25 more
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.
Boolean read/write If true, places grids behind all other objects on the spread.
Number 1–1000 read/write The number of rows into which to subdivide the space between horizontal document grid lines.
Number | String unit read/write The amount of space between major horizontal lines in the document grid.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Application | Document readonly The parent of the GridPreference (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.
Number 1–1000 read/write The number of columns into which to subdivide the space between vertical document grid lines.
Number | String unit read/write The amount of space between major vertical lines in the document grid.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
GridPreference[]

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

Boolean

Removes the event listener.

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

Generates a string which, if executed, will return the GridPreference.

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a GridPreference.

Return 1

Methods that return a GridPreference.