NumberingList

A numbered list.

Methods:

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Objects:

Boolean, Number, Object, String

Property Listing

Property

Type

Access

Description

continueNumbersAcrossDocuments

Boolean

read/write

if true, numbering will continue across book documents.

continueNumbersAcrossStories

Boolean

read/write

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

read/write

A property that can be set to any string.

name

String

read/write

The name of the NumberingList.

parent

Application

Document

readonly

The parent of the NumberingList (a Application or Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

NumberingList getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined 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.