Indexes
A collection of indexes.
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
Index [] (index:Number)
Returns the Index with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Index add (withProperties:Object)
Creates a new Index.
|
Parameter |
Type |
Description |
|---|---|---|
|
withProperties |
Initial values for properties of the new Index (Optional) |
Index anyItem ()
Returns any Index in the collection.
Number count ()
Displays the number of elements in the Index.
Index everyItem ()
Returns every Index in the collection.
Index firstItem ()
Returns the first Index in the collection.
Index item (index:Varies LongInteger String)
Returns the Index with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
Index itemByID (id:Number)
Returns the Index with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Index itemByName (name:String)
Returns the Index with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Index itemByRange (from:Varies Index LongInteger String, to:Varies Index LongInteger String)
Returns the Indexes within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Index LongInteger |
The Index, index, or name at the beginning of the range. Can accept: Index, Long Integer or String. |
|
to |
Index LongInteger |
The Index, index, or name at the end of the range. Can accept: Index, Long Integer or String. |
Index lastItem ()
Returns the last Index in the collection.
Index middleItem ()
Returns the middle Index in the collection.
Index nextItem (obj:Index_)
Returns the Index whose index follows the specified Index in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Index whose index comes before the desired Index. |
Index previousItem (obj:Index_)
Returns the Index with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Index that follows the desired Index. |
String toSource ()
Generates a string which, if executed, will return the Index.
Object of
Document.indexes