A collection of spreads.
Methods
Spreadadd ([at:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object])
Creates a new spread.
| Parameter | Type | Description |
|---|---|---|
| at | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location of the spread relative to the reference object or within the document. (Optional) (default: UNKNOWN ) |
| reference | Spread Document |
The reference object. Note: Required when the at parameter specifies before or after. Can accept: Spread or Document. (Optional) |
| withProperties | Object | Initial values for properties of the new Spread (Optional) |
SpreadanyItem ()
Returns any Spread in the collection.
number count ()
Displays the number of elements in the Spread.
Array of SpreadeveryItem ()
Returns every Spread in the collection.
SpreadfirstItem ()
Returns the first Spread in the collection.
Spreaditem (index:
any)
Returns the Spread with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
SpreaditemByID (id:
number)
Returns the Spread with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
SpreaditemByName (name:
string)
Returns the Spread with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of SpreaditemByRange (from:
any, to:
any)
Returns the Spreads within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Spread Long Integer String |
The Spread, index, or name at the beginning of the range. Can accept: Spread, Long Integer or String. |
| to | Spread Long Integer String |
The Spread, index, or name at the end of the range. Can accept: Spread, Long Integer or String. |
SpreadlastItem ()
Returns the last Spread in the collection.
SpreadmiddleItem ()
Returns the middle Spread in the collection.
SpreadnextItem (obj:
Spread)
Returns the Spread whose index follows the specified Spread in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Spread | The Spread whose index comes before the desired Spread. |
SpreadpreviousItem (obj:
Spread)
Returns the Spread with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Spread | The index of the Spread that follows the desired Spread. |
string toSource ()
Generates a string which, if executed, will return the Spread.
Element of:
Document.spreads