BaselineFrameGridOption

Baseline frame grid options.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

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

Hierarchy:

Superclass: Preference

Class: BaselineFrameGridOption

Property Listing

Property

Type

Access

Description

baselineFrameGridColor

Array of 3 Reals (0 - 255)

UIColors

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.

baselineFrameGridIncrement

Number

String

read/write

The distance between grid lines.

baselineFrameGridRelativeOption

BaselineFrameGridRelativeOption

BaselineFrameGridRelativeOption.TOP_OF_FRAME

BaselineFrameGridRelativeOption.TOP_OF_INSET

BaselineFrameGridRelativeOption.TOP_OF_MARGIN

BaselineFrameGridRelativeOption.TOP_OF_PAGE

read/write

The location (top of page, top margin, top of frame, or frame inset) on which to base the custom baseline grid.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Document

EndnoteTextFrame

TextFrame

Application

ObjectStyle

readonly

The parent of the BaselineFrameGridOption (a Application, Document, TextFrame, EndnoteTextFrame or ObjectStyle).

properties

Object

read/write

A property that allows setting of several properties at the same time.

startingOffsetForBaselineFrameGrid

Number

String

read/write

The amount to offset the baseline grid.

useCustomBaselineFrameGrid

Boolean

read/write

If true, uses a custom baseline frame 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)

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

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.baselineFrameGridOptions

Document.baselineFrameGridOptions

ObjectStyle.baselineFrameGridOptions

TextFrame.baselineFrameGridOptions

EndnoteTextFrame.baselineFrameGridOptions

Event.parent

EventListener.parent

MutationEvent.parent

Return

BaselineFrameGridOption.getElements()