Class
Chapter numbering preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
ChapterNumberPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| chapterNumber | number | r/w | Chapter number. |
| chapterNumberFormat | NumberingStyleString | r/w | Chapter number formatting options. Can return: NumberingStyle enumerator or String. |
| chapterNumberSource | ChapterNumberSources: ChapterNumberSources.USER_DEFINED ChapterNumberSources.CONTINUE_FROM_PREVIOUS_DOCUMENT ChapterNumberSources.SAME_AS_PREVIOUS_DOCUMENT |
r/w | Source for generating the chapter number. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Document | readonly | The parent of the ChapterNumberPreference (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of ChapterNumberPreference getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the ChapterNumberPreference.
Element of
Document.chapterNumberPreferences
Return
Array of ChapterNumberPreference ChapterNumberPreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |