Adobe InDesign CS5 Server (7.0) Object Model JS: ChapterNumberPreference

InDesign Server CS5

Class

ChapterNumberPreference

 Chapter numbering preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Document
Preference
ChapterNumberPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
chapterNumbernumber r/wChapter number.
chapterNumberFormatNumberingStyleString r/wChapter number formatting options. Can return: NumberingStyle enumerator or String.
chapterNumberSourceChapterNumberSources:
ChapterNumberSources.USER_DEFINED
ChapterNumberSources.CONTINUE_FROM_PREVIOUS_DOCUMENT
ChapterNumberSources.SAME_AS_PREVIOUS_DOCUMENT
r/wSource for generating the chapter number.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentDocument readonlyThe parent of the ChapterNumberPreference (a Document).
propertiesObject r/wA 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Document.chapterNumberPreferences

Return

Array of ChapterNumberPreference ChapterNumberPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index