NamedGrids
A collection of named grids.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
NamedGrid [] (index:Number)
Returns the NamedGrid with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
NamedGrid add (withProperties:Object)
Creates a new NamedGrid.
|
Parameter |
Type |
Description |
|---|---|---|
|
withProperties |
Initial 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.
NamedGrid everyItem ()
Returns every NamedGrid in the collection.
NamedGrid firstItem ()
Returns the first NamedGrid in the collection.
NamedGrid item (index:Varies LongInteger String)
Returns the NamedGrid with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
NamedGrid itemByID (id:Number)
Returns the NamedGrid with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
NamedGrid itemByName (name:String)
Returns the NamedGrid with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
NamedGrid itemByRange (from:Varies LongInteger NamedGrid String, to:Varies LongInteger NamedGrid String)
Returns the NamedGrids within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The NamedGrid, index, or name at the beginning of the range. Can accept: NamedGrid, Long Integer or String. |
|
to |
LongInteger |
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The NamedGrid whose index comes before the desired NamedGrid. |
NamedGrid previousItem (obj:NamedGrid)
Returns the NamedGrid with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the NamedGrid that follows the desired NamedGrid. |
String toSource ()
Generates a string which, if executed, will return the NamedGrid.
Object of
Application.namedGrids
Document.namedGrids