Adobe InDesign CS6 Server (8.0) Object Model JS: NamedGrids

InDesign Server CS6

Class

NamedGrids

 A collection of named grids.

See also NamedGrid.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

NamedGrid [] (index: number)
Returns the NamedGrid with the specified index.

ParameterTypeDescription
indexnumberThe index.

NamedGrid add ([withProperties: Object])
Creates a new NamedGrid.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new NamedGrid (Optional)

NamedGrid anyItem ()
Returns any NamedGrid in the collection.

number count ()
Displays the number of elements in the NamedGrid.

Array of NamedGrid everyItem ()
Returns every NamedGrid in the collection.

NamedGrid firstItem ()
Returns the first NamedGrid in the collection.

NamedGrid item (index: varies)
Returns the NamedGrid with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

NamedGrid itemByID (id: number)
Returns the NamedGrid with the specified ID.

ParameterTypeDescription
idnumberThe ID.

NamedGrid itemByName (name: string)
Returns the NamedGrid with the specified name.

ParameterTypeDescription
namestringThe name.

Array of NamedGrid itemByRange (from: varies, to: varies)
Returns the NamedGrids within the specified range.

ParameterTypeDescription
fromLong Integer
NamedGrid
String
The NamedGrid, index, or name at the beginning of the range. Can accept: NamedGrid, Long Integer or String.
toLong Integer
NamedGrid
String
The NamedGrid, index, or name at the end of the range. Can accept: NamedGrid, Long Integer or String.

NamedGrid lastItem ()
Returns the last NamedGrid in the collection.

NamedGrid middleItem ()
Returns the middle NamedGrid in the collection.

NamedGrid nextItem (obj: NamedGrid)
Returns the NamedGrid whose index follows the specified NamedGrid in the collection.

ParameterTypeDescription
objNamedGridThe NamedGrid whose index comes before the desired NamedGrid.

NamedGrid previousItem (obj: NamedGrid)
Returns the NamedGrid with the index previous to the specified index.

ParameterTypeDescription
objNamedGridThe index of the NamedGrid that follows the desired NamedGrid.

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

Element of

Application.namedGrids

Document.namedGrids

Jongware, 28-Apr-2012 v3.0.3iContents :: Index