PageNumberVariablePreference

The preferences for a page number variable.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Object, String, VariableNumberingStyles, VariableScopes

Hierarchy:

Superclass: Preference

Class: PageNumberVariablePreference

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

format

VariableNumberingStyles

VariableNumberingStyles.ARABIC

VariableNumberingStyles.CURRENT

VariableNumberingStyles.DOUBLE_LEADING_ZEROS

VariableNumberingStyles.FULL_WIDTH_ARABIC

VariableNumberingStyles.KANJI

VariableNumberingStyles.LOWER_LETTERS

VariableNumberingStyles.LOWER_ROMAN

VariableNumberingStyles.SINGLE_LEADING_ZEROS

VariableNumberingStyles.UPPER_LETTERS

VariableNumberingStyles.UPPER_ROMAN

read/write

The format for the variable.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

TextVariable

readonly

The parent of the PageNumberVariablePreference (a TextVariable).

properties

Object

read/write

A property that allows setting of several properties at the same time.

scope

VariableScopes

VariableScopes.DOCUMENT_SCOPE

VariableScopes.SECTION_SCOPE

read/write

The scope or range of the pages to include.

textAfter

String

read/write

The text that follows the value of the variable. (Limit: 128 characters)

textBefore

String

read/write

The text that precedes the value of the variable. (Limit: 128 characters)

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

PageNumberVariablePreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

TextVariable.variableOptions

Return

PageNumberVariablePreference.getElements()