InDesign2026
API 21.5.1.73
Object

BaselineFrameGridOption

Baseline frame grid options.

Preference BaselineFrameGridOption
Hierarchy

Application | Document | EndnoteTextFrame | ObjectStyle | TextFrame

BaselineFrameGridOption

Properties

NameType AccessDescription
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write 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.
Number | String unit read/write The distance between grid lines.
BaselineFrameGridRelativeOption
read/write The location (top of page, top margin, top of frame, or frame inset) on which to base the custom baseline grid.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Document | EndnoteTextFrame | TextFrame | Application | ObjectStyle readonly The parent of the BaselineFrameGridOption (a Application, Document, TextFrame, EndnoteTextFrame or ObjectStyle).
Object read/write A property that allows setting of several properties at the same time.
Number | String unit read/write The amount to offset the baseline grid.
Boolean read/write If true, uses a custom baseline frame 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.
BaselineFrameGridOption[]

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

String

Retrieves the object specifier.

Object of 8

Properties elsewhere that hold a BaselineFrameGridOption.

Return 1

Methods that return a BaselineFrameGridOption.