InDesign2026
API 21.5.1.73
Object

CjkGridPreference

Character grid preferences.

Preference CjkGridPreference
Hierarchy

Application | Document

CjkGridPreference

Properties

NameType AccessDescription
Number read/write Applies the grid color to every nth cell, where n is the value of this property.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, uses ICF mode for grid cells. If false, uses virtual body mode.
Boolean readonly Returns true if the object specifier resolves to valid objects.
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write 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.
Number 5–4000 read/write The view magnification (as a percentage) less than which grids do not appear. (Range: 5 to 4000)
Application | Document readonly The parent of the CjkGridPreference (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write If true, displays the frame (story) grids.
Boolean read/write If true, displays the layout grids.
Boolean read/write If true, displays the character count for the frame.
Boolean read/write 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.
Boolean read/write If true, objects snap to the layout grid.
Boolean read/write If true, cell shape is circular. If false, cell shape is rectangular.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
CjkGridPreference[]

Resolves the object specifier, creating an array of object references.

Boolean

Removes the event listener.

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

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

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a CjkGridPreference.

Return 1

Methods that return a CjkGridPreference.