K4 InDesign Javascript API Documentation

TextNumberingLists

A collection of numbered lists.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
name ​[, continueNumbersAcrossStories] ​[, continueNumbersAcrossDocuments] ​[, withProperties])
  → NumberingList
anyItem(
)
  → NumberingList
count(
)
  → number
everyItem(
)
  → NumberingList
firstItem(
)
  → NumberingList
item(
index)
  → NumberingList
itemByID(
id)
  → NumberingList
itemByName(
name)
  → NumberingList
itemByRange(
from, to)
  → NumberingList
lastItem(
)
  → NumberingList
middleItem(
)
  → NumberingList
nextItem(
obj)
  → NumberingList
previousItem(
obj)
  → NumberingList
toSource(
)
  → string
add(
name ​[, continueNumbersAcrossStories] ​[, continueNumbersAcrossDocuments] ​[, withProperties])
  → NumberingList
Create a new list style.
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)
anyItem(
)
  → NumberingList
Returns any NumberingList in the collection.
count(
)
  → number
Displays the number of elements in the NumberingList.
everyItem(
)
  → NumberingList
Returns every NumberingList in the collection.
firstItem(
)
  → NumberingList
Returns the first NumberingList in the collection.
item(
index)
  → NumberingList
Returns the NumberingList with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → NumberingList
Returns the NumberingList with the specified ID.
id number The ID.
itemByName(
name)
  → NumberingList
Returns the NumberingList with the specified name.
name string The name.
itemByRange(
from, to)
  → NumberingList
Returns the NumberingLists within the specified range.
from The NumberingList, index, or name at the beginning of the range. Can accept: NumberingList, Long Integer or String.
to The NumberingList, index, or name at the end of the range. Can accept: NumberingList, Long Integer or String.
lastItem(
)
  → NumberingList
Returns the last NumberingList in the collection.
middleItem(
)
  → NumberingList
Returns the middle NumberingList in the collection.
nextItem(
obj)
  → NumberingList
Returns the NumberingList whose index follows the specified NumberingList in the collection.
obj NumberingList The NumberingList whose index comes before the desired NumberingList.
previousItem(
obj)
  → NumberingList
Returns the NumberingList with the index previous to the specified index.
obj NumberingList The index of the NumberingList that follows the desired NumberingList.
toSource(
)
  → string
Generates a string which, if executed, will return the NumberingList.