Adobe InCopy CS6 (8.0) Object Model JS: GridPreference

InCopy CS6

Class

GridPreference

 Grid preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
GridPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
baselineColor3 Reals (0 - 255)
UIColors
r/wThe 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.
baselineDivisionMeasurement Unit (Number or String) (range: 1 - 8640) r/wThe amount of space between baseline grid lines.
baselineGridShownbool r/wIf true, displays the baseline grid.
baselineStartMeasurement Unit (Number or String) (range: 0 - 1000) r/wThe amount to offset the baseline grid from the zero point.
baselineViewThresholdnumber (range: 5 - 4000) r/wThe magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)
documentGridShownbool r/wIf true, displays the document grid.
documentGridSnaptobool r/wIf true, an object snaps to the nearest grid line when the object is created, moved, or resized.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
gridColor3 Reals (0 - 255)
UIColors
r/wThe 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.
gridsInBackbool r/wIf true, places grids behind all other objects on the spread.
horizontalGridSubdivisionnumber (range: 1 - 1000) r/wThe number of rows into which to subdivide the space between horizontal document grid lines.
horizontalGridlineDivisionMeasurement Unit (Number or String) (range: 0.01 - 1000) r/wThe amount of space between major horizontal lines in the document grid.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Document
readonlyThe parent of the GridPreference (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
verticalGridSubdivisionnumber (range: 1 - 1000) r/wThe number of columns into which to subdivide the space between vertical document grid lines.
verticalGridlineDivisionMeasurement Unit (Number or String) (range: 0.01 - 1000) r/wThe amount of space between major vertical lines in the document 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 GridPreference 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 GridPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.gridPreferences

Document.gridPreferences

Return

Array of GridPreference GridPreference.getElements ()

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