Class

NamedGrid

 A named grid.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document

NamedGrid

Event | EventListener | GridDataInformation | MutationEvent | Preference

Properties

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

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of NamedGrid getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove ()
Deletes the NamedGrid.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the NamedGrid.

string toSpecifier ()
Retrieves the object specifier.

Element of

GridDataInformation.parent

ObjectStyle.appliedNamedGrid

Story.appliedNamedGrid

TextDefault.appliedNamedGrid

XmlStory.appliedNamedGrid

Used in:

NamedGrid NamedGrids.nextItem (obj: NamedGrid)

NamedGrid NamedGrids.previousItem (obj: NamedGrid)

Return

Array of NamedGrid NamedGrid.getElements ()

NamedGrid NamedGrids.[] (index: number)

NamedGrid NamedGrids.add ([withProperties: Object])

NamedGrid NamedGrids.anyItem ()

Array of NamedGrid NamedGrids.everyItem ()

NamedGrid NamedGrids.firstItem ()

NamedGrid NamedGrids.item (index: varies)

NamedGrid NamedGrids.itemByID (id: number)

NamedGrid NamedGrids.itemByName (name: string)

Array of NamedGrid NamedGrids.itemByRange (from: varies, to: varies)

NamedGrid NamedGrids.lastItem ()

NamedGrid NamedGrids.middleItem ()

NamedGrid NamedGrids.nextItem (obj: NamedGrid)

NamedGrid NamedGrids.previousItem (obj: NamedGrid)

Jongware, 23-Mar-2011 v3.0.3d

Contents :: Index