Adobe InDesign CS5 Server (7.0) Object Model JS: CjkGridPreference

InDesign Server CS5

Class

CjkGridPreference

 Character grid preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
CjkGridPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
colorEveryNthCellnumber r/wApplies the grid color to every nth cell, where n is the value of this property.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
icfModebool r/wIf true, uses ICF mode for grid cells. If false, uses virtual body mode.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
layoutGridColorIndex3 Reals (0 - 255)
UIColors
r/wThe layout grid 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.
minimumScalenumber r/wThe view magnification (as a percentage) less than which grids do not appear. (Range: 5 to 4000)
parentApplication
Document
readonlyThe parent of the CjkGridPreference (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
showAllFrameGridsbool r/wIf true, displays the frame (story) grids.
showAllLayoutGridsbool r/wIf true, displays the layout grids.
showCharacterCountbool r/wIf true, displays the character count for the frame.
singleLineColorModebool r/wIf true, applies the grid color from the the edge of the line. If false, applies the grid color from the corner of the frame.
snapToLayoutGridbool r/wIf true, objects snap to the layout grid.
useCircularCellsbool r/wIf true, cell shape is circular. If false, cell shape is rectangular.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.cjkGridPreferences

Document.cjkGridPreferences

Return

Array of CjkGridPreference CjkGridPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index