Class
The preferences for a page number variable. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
PageNumberVariablePreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| format | VariableNumberingStyles: 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 |
r/w | The format for the variable. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | TextVariable | readonly | The parent of the PageNumberVariablePreference (a TextVariable). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| scope | VariableScopes: VariableScopes.DOCUMENT_SCOPE VariableScopes.SECTION_SCOPE |
r/w | The scope or range of the pages to include. |
| textAfter | string | r/w | The text that follows the value of the variable. (Limit: 128 characters) |
| textBefore | string | r/w | The text that precedes the value of the variable. (Limit: 128 characters) |
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 PageNumberVariablePreference 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 PageNumberVariablePreference.
Element of
TextVariable.variableOptions
Return
Array of PageNumberVariablePreference PageNumberVariablePreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |