The preferences for a chapter number variable.
Go to Property Listing | Method Listing
toSource, getElements, toSpecifier, addEventListener, removeEventListener
Boolean, EventListeners, Events, Object, String, TextVariable, VariableNumberingStyles,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
format |
VariableNumberingStyles.CURRENT VariableNumberingStyles.ARABIC VariableNumberingStyles.UPPER_ROMAN VariableNumberingStyles.LOWER_ROMAN VariableNumberingStyles.UPPER_LETTERS VariableNumberingStyles.LOWER_LETTERS VariableNumberingStyles.SINGLE_LEADING_ZEROS VariableNumberingStyles.DOUBLE_LEADING_ZEROS VariableNumberingStyles.KANJI VariableNumberingStyles.FULL_WIDTH_ARABIC |
read/write |
The format for the variable. |
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
parent |
readonly |
The parent of the ChapterNumberVariablePreference (a TextVariable). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
textAfter |
read/write |
The text that follows the value of the variable. (Limit: 128 characters) |
|
|
textBefore |
read/write |
The text that precedes the value of the variable. (Limit: 128 characters) |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
ChapterNumberVariablePreference getElements ()
Resolves the object specifier, creating an array of object references.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the ChapterNumberVariablePreference.
String toSpecifier ()
Retrieves the object specifier.