NumberingLists

A collection of numbered lists.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

NumberingList [] (index:Number)

Returns the NumberingList with the specified index.

Parameter

Type

Description

index

Number

The index.

NumberingList add (name:String, continueNumbersAcrossStories:Boolean, continueNumbersAcrossDocuments:Boolean, withProperties:Object)

Create a new list style.

Parameter

Type

Description

name

String

Name

continueNumbersAcrossStories

Boolean

If true, numbering will continue across stories. (Optional)

continueNumbersAcrossDocuments

Boolean

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.

NumberingList everyItem ()

Returns every NumberingList in the collection.

NumberingList firstItem ()

Returns the first NumberingList in the collection.

NumberingList item (index:Varies LongInteger String)

Returns the NumberingList with the specified index or name.

Parameter

Type

Description

index

LongInteger

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.

NumberingList itemByRange (from:Varies LongInteger NumberingList String, to:Varies LongInteger NumberingList String)

Returns the NumberingLists within the specified range.

Parameter

Type

Description

from

LongInteger

NumberingList

String

The NumberingList, index, or name at the beginning of the range. Can accept: NumberingList, Long Integer or String.

to

LongInteger

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.