InDesign2026
API 21.5.1.73
Object

NamedGrid

A named grid.

Hierarchy

Application | Document

NamedGrid

2 preference objects

GridDataInformation | Preference

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
GridDataInformation readonly Default grid properties. Note: Applies to named, layout, and frame (story) grids.
Number readonly The unique ID of the NamedGrid.
Number readonly The index of the NamedGrid within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the NamedGrid.
Application | Document readonly The parent of the NamedGrid (a Document or Application).
Preferences<Preference> readonly A collection of preferences objects.
Object read/write A property that allows setting of several properties at the same time.

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

Gets the label value associated with the specified key.

key String The key.
NamedGrid[]

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

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
void

Deletes the NamedGrid.

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

String

Retrieves the object specifier.

Object of 8

Properties elsewhere that hold a NamedGrid.

Parameter of 3

Method parameters that accept a NamedGrid.

Return 14

Methods that return a NamedGrid.