PageNumberVariablePreference

The preferences for a page number variable.

Methods:

getElements, toSource, toSpecifier

Objects:

Boolean, Object, String, VariableNumberingStyles, VariableScopes

Hierarchy:

Superclass: Preference

Class: PageNumberVariablePreference

Property Listing

Property

Type

Access

Description

format

VariableNumberingStyles

VariableNumberingStyles.ARABIC

VariableNumberingStyles.CURRENT

VariableNumberingStyles.DOUBLE_LEADING_ZEROS

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

PageNumberVariablePreference getElements ()

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

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

TextVariable.variableOptions

Return

PageNumberVariablePreference.getElements()