Adobe InCopy CS6 (8.0) Object Model JS: PageNumberVariablePreference

InCopy CS6

Class

PageNumberVariablePreference

 The preferences for a page number variable. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

TextVariable
Preference
PageNumberVariablePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
formatVariableNumberingStyles:
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/wThe format for the variable.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentTextVariable readonlyThe parent of the PageNumberVariablePreference (a TextVariable).
propertiesObject r/wA property that allows setting of several properties at the same time.
scopeVariableScopes:
VariableScopes.DOCUMENT_SCOPE
VariableScopes.SECTION_SCOPE
r/wThe scope or range of the pages to include.
textAfterstring r/wThe text that follows the value of the variable. (Limit: 128 characters)
textBeforestring r/wThe 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.

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 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.

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 PageNumberVariablePreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

TextVariable.variableOptions

Return

Array of PageNumberVariablePreference PageNumberVariablePreference.getElements ()

Jongware, 29-Apr-2012 v3.0.3iContents :: Index