Adobe InCopy CS5.5 (7.5) Object Model JS: BaselineFrameGridOption

InCopy CS5.5

Class

BaselineFrameGridOption

 Baseline frame grid options. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document | TextFrame
Preference
BaselineFrameGridOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
baselineFrameGridColor3 Reals (0 - 255)
UIColors
readonlyThe 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.
baselineFrameGridIncrementMeasurement Unit (Number or String) (range: 1 - 8640) readonlyThe distance between grid lines.
baselineFrameGridRelativeOptionBaselineFrameGridRelativeOption:
BaselineFrameGridRelativeOption.TOP_OF_PAGE
BaselineFrameGridRelativeOption.TOP_OF_MARGIN
BaselineFrameGridRelativeOption.TOP_OF_FRAME
BaselineFrameGridRelativeOption.TOP_OF_INSET
readonlyThe location (top of page, top margin, top of frame, or frame inset) on which to base the custom baseline grid.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Document
TextFrame
readonlyThe parent of the BaselineFrameGridOption (a Application, Document or TextFrame).
propertiesObject r/wA property that allows setting of several properties at the same time.
startingOffsetForBaselineFrameGridMeasurement Unit (Number or String) (range: 0 - 8640) readonlyThe amount to offset the baseline grid.
useCustomBaselineFrameGridbool readonlyIf true, uses a custom baseline frame grid.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of BaselineFrameGridOption getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.baselineFrameGridOptions

Document.baselineFrameGridOptions

TextFrame.baselineFrameGridOptions

Return

Array of BaselineFrameGridOption BaselineFrameGridOption.getElements ()

Jongware, 29-Apr-2012 v3.0.3iContents :: Index