NamedGrid

A named grid.

Instance

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

Methods

remove()
Deletes the NamedGrid.
insertLabel( String key, String value )
Sets the label to the value associated with the specified key.
Parameters
Type Name Description
String
key
The key.
String
value
The value.

Type	Name	Description
String	key	The key.
String	value	The value.

String extractLabel( String key )
Gets the label value associated with the specified key.
Parameters
Type Name Description
String
key
The key.

Type	Name	Description
String	key	The key.

String toSource()
Generates a string which, if executed, will return the NamedGrid.
NamedGrid getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description
String
eventType
The event type.
Mixed
handler
The event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)

Type	Name	Description
String	eventType	The event type.
Mixed	handler	The event handler. Can accept: File or JavaScript Function.
Boolean	captures	This parameter is obsolete. (Optional)

Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description
String
eventType
The registered event type.
Mixed
handler
The registered event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)

Type	Name	Description
String	eventType	The registered event type.
Mixed	handler	The registered event handler. Can accept: File or JavaScript Function.
Boolean	captures	This parameter is obsolete. (Optional)