ChapterNumberPreference

Chapter numbering preferences.

Methods:

getElements, toSource, toSpecifier

Objects:

Boolean, ChapterNumberSources, 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.DOUBLE_LEADING_ZEROS

NumberingStyle.FORMAT_NONE

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.

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

ChapterNumberPreference getElements ()

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

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Document.chapterNumberPreferences

Return

ChapterNumberPreference.getElements()