A numbered list.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| continueNumbersAcrossDocuments | bool | r/w | if true, numbering will continue across book documents. |
| continueNumbersAcrossStories | bool | r/w | If true, numbering will continue across stories. |
| id | number | readonly | The unique ID of the NumberingList. |
| index | number | readonly | The index of the NumberingList within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the NumberingList. |
| parent | any | readonly | The parent of the NumberingList (a Application or Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of NumberingListgetElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ([replacingWith:
NumberingList])
Delete the NumberingList.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | NumberingList | The NumberingList to apply in place of this one. (Optional) |
string toSource ()
Generates a string which, if executed, will return the NumberingList.
string toSpecifier ()
Retrieves the object specifier.
Used in:
NumberingList.remove (
[replacingWith:
NumberingList ])
NumberingLists.previousItem (
obj:
NumberingList )
NumberingLists.nextItem (
obj:
NumberingList )
Returned by:
Array of NumberingList NumberingList .getElements (
)
NumberingList NumberingLists.add (
name:
string[, continueNumbersAcrossStories:
bool][, continueNumbersAcrossDocuments:
bool][, withProperties:
Object]
)
NumberingList NumberingLists.anyItem (
)
Array of NumberingList NumberingLists.everyItem (
)
NumberingList NumberingLists.firstItem (
)
NumberingList NumberingLists.item (
index:
any
)
NumberingList NumberingLists.itemByID (
id:
number
)
NumberingList NumberingLists.itemByName (
name:
string
)
Array of NumberingList NumberingLists.itemByRange (
from:
any, to:
any
)
NumberingList NumberingLists.lastItem (
)
NumberingList NumberingLists.middleItem (
)
NumberingList NumberingLists.nextItem (
obj:
NumberingList
)
NumberingList NumberingLists.previousItem (
obj:
NumberingList
)