NumberingLists
See also NumberingList.
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
NumberingList [] (index:
number)
Returns the NumberingList with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
NumberingList add (name:
string[, continueNumbersAcrossStories:
bool][, continueNumbersAcrossDocuments:
bool][, withProperties:
Object])
Create a new list style.
| Parameter | Type | Description |
|---|---|---|
| name | string | Name |
| continueNumbersAcrossStories | bool | If true, numbering will continue across stories. (Optional) |
| continueNumbersAcrossDocuments | bool | If true, numbering will continue across book documents. (Optional) |
| withProperties | Object | Initial values for properties of the new NumberingList (Optional) |
NumberingList anyItem ()
Returns any NumberingList in the collection.
number count ()
Displays the number of elements in the NumberingList.
Array
of NumberingList everyItem ()
Returns every NumberingList in the collection.
NumberingList firstItem ()
Returns the first NumberingList in the collection.
NumberingList item (index:
varies)
Returns the NumberingList with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
NumberingList itemByID (id:
number)
Returns the NumberingList with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
NumberingList itemByName (name:
string)
Returns the NumberingList with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of NumberingList itemByRange (from:
varies, to:
varies)
Returns the NumberingLists within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer NumberingList String | The NumberingList, index, or name at the beginning of the range. Can accept: NumberingList, Long Integer or String. |
| to | Long Integer NumberingList String | The NumberingList, index, or name at the end of the range. Can accept: NumberingList, Long Integer or String. |
NumberingList lastItem ()
Returns the last NumberingList in the collection.
NumberingList middleItem ()
Returns the middle NumberingList in the collection.
NumberingList nextItem (obj:
NumberingList)
Returns the NumberingList whose index follows the specified NumberingList in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | NumberingList | The NumberingList whose index comes before the desired NumberingList. |
NumberingList previousItem (obj:
NumberingList)
Returns the NumberingList with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | NumberingList | The index of the NumberingList that follows the desired NumberingList. |
string toSource ()
Generates a string which, if executed, will return the NumberingList.
Element of
Application.numberingLists
Document.numberingLists
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |