NumberingList

A numbered list.

Go to Property Listing | Method Listing

Methods:

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, 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.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	Number	readonly	The unique ID of the NumberingList.
index	Number	readonly	The index of the NumberingList within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
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

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

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)

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the NumberingList.

String toSpecifier ()

Retrieves the object specifier.