K4 InDesign Javascript API Documentation

PreferencesCjkGridPreference

Character grid preferences.

Extends

Instance Properties

Name Description Access
colorEveryNthCell number Applies the grid color to every nth cell, where n is the value of this property. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
icfMode bool If true, uses ICF mode for grid cells. If false, uses virtual body mode. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
layoutGridColorIndex The 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. read-write
minimumScale number The view magnification (as a percentage) less than which grids do not appear. (Range: 5 to 4000) read-write
parent The parent of the CjkGridPreference (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
showAllFrameGrids bool If true, displays the frame (story) grids. read-write
showAllLayoutGrids bool If true, displays the layout grids. read-write
showCharacterCount bool If true, displays the character count for the frame. read-write
singleLineColorMode bool If true, applies the grid color from the the edge of the line. If false, applies the grid color from the corner of the frame. read-write
snapToLayoutGrid bool If true, objects snap to the layout grid. read-write
useCircularCells bool If true, cell shape is circular. If false, cell shape is rectangular. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → CjkGridPreference
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(
)
  → CjkGridPreference
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 CjkGridPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.