K4 InDesign Javascript API Documentation

TextNamedGrid

A named grid.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
gridData GridDataInformation Default grid properties. Note: Applies to named, layout, and frame (story) grids. read-only
id number The unique ID of the NamedGrid. read-only
index number The index of the NamedGrid within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the NamedGrid. read-write
parent The parent of the NamedGrid (a Document or Application). read-only
preferences Preferences A collection of preferences objects. read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → NamedGrid
insertLabel(
key, value)
remove(
)
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)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → NamedGrid
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the NamedGrid.
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 NamedGrid.
toSpecifier(
)
  → string
Retrieves the object specifier.