K4 InDesign Javascript API Documentation

PreferencesBaselineFrameGridOption

Baseline frame grid options.

Extends

Instance Properties

Name Description Access
baselineFrameGridColor 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. read-write
baselineFrameGridIncrement Measurement Unit (Number or String)=any The distance between grid lines. read-write
baselineFrameGridRelativeOption BaselineFrameGridRelativeOption The location (top of page, top margin, top of frame, or frame inset) on which to base the custom baseline grid. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the BaselineFrameGridOption (a Application, Document, TextFrame, EndnoteTextFrame or ObjectStyle). read-only
properties Object A property that allows setting of several properties at the same time. read-write
startingOffsetForBaselineFrameGrid Measurement Unit (Number or String)=any The amount to offset the baseline grid. read-write
useCustomBaselineFrameGrid bool If true, uses a custom baseline frame grid. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → BaselineFrameGridOption
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → BaselineFrameGridOption
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the BaselineFrameGridOption.
toSpecifier(
)
  → string
Retrieves the object specifier.