ChapterNumberPreference

Chapter numbering preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, ChapterNumberSources, EventListeners, Events, Number, NumberingStyle, Object, String,

Hierarchy:

Superclass: Preference

Class: ChapterNumberPreference

Property Listing

Property

Type

Access

Description

chapterNumber

Number

read/write

Chapter number.

chapterNumberFormat

NumberingStyle

NumberingStyle.ARABIC

NumberingStyle.ARABIC_ABJAD

NumberingStyle.ARABIC_ALIF_BA_TAH

NumberingStyle.DOUBLE_LEADING_ZEROS

NumberingStyle.FORMAT_NONE

NumberingStyle.HEBREW_BIBLICAL

NumberingStyle.HEBREW_NON_STANDARD

NumberingStyle.KANJI

NumberingStyle.KATAKANA_MODERN

NumberingStyle.KATAKANA_TRADITIONAL

NumberingStyle.LOWER_LETTERS

NumberingStyle.LOWER_ROMAN

NumberingStyle.SINGLE_LEADING_ZEROS

NumberingStyle.TRIPLE_LEADING_ZEROS

NumberingStyle.UPPER_LETTERS

NumberingStyle.UPPER_ROMAN

String

read/write

Chapter number formatting options. Can return: NumberingStyle enumerator or String.

chapterNumberSource

ChapterNumberSources

ChapterNumberSources.CONTINUE_FROM_PREVIOUS_DOCUMENT

ChapterNumberSources.SAME_AS_PREVIOUS_DOCUMENT

ChapterNumberSources.USER_DEFINED

read/write

Source for generating the chapter number.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Document

readonly

The parent of the ChapterNumberPreference (a 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)

ChapterNumberPreference getElements ()

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

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)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Document.chapterNumberPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

ChapterNumberPreference.getElements()