Page

A page.

Methods:

addEventListener, contentPlace, deleteAllLayoutSnapshots, deleteLayoutSnapshot, detach, duplicate, extractLabel, getElements, insertLabel, move, place, placeAndLink, placeXML, reframe, remove, removeEventListener, removeOverride, resize, resolve, select, setContent, snapshotCurrentLayout, toSource, toSpecifier, transform, transformValuesOf

Objects:

Boolean, Buttons, CheckBoxes, ComboBoxes, EPSTexts, EventListeners, Events, FormFields, Graphic, GraphicLines, Graphics, GridDataInformation, Groups, Guides, LayoutRuleOptions, ListBoxes, MarginPreference, MasterSpread, Movies, MultiStateObjects, NothingEnum, Number, Object, Ovals, PageColorOptions, PageItem, PageItems, PageSideOptions, Polygons, Preferences, RadioButtons, Rectangles, Section, SignatureFields, SnapshotBlendingModes, Sounds, SplineItems, String, TextBoxes, TextFrames, TransformationMatrix, TrapPreset, TypefiElementAnchors, TypefiPageSettings, UIColors,

Preferences:

MarginPreference, Preferences

Property Listing

Property

Type

Access

Description

allGraphics

Array of Graphic

readonly

Lists all graphics contained by the Page.

allPageItems

Array of PageItem

readonly

Lists all page items contained by the Page.

appliedAlternateLayout

Section

readonly

The alternate layout section to which the page belongs.

appliedMaster

MasterSpread

NothingEnum.NOTHING

read/write

The master spread applied to the Page. Can also accept: NothingEnum enumerator.

appliedSection

Section

readonly

The section to which the page belongs.

appliedTrapPreset

TrapPreset

String

read/write

The trap preset applied to the page. Can also accept: String.

bounds

Array of Number

Array of String

readonly

The bounds of the Page, in the format [y1, x1, y2, x2].

buttons

Buttons Button

readonly

A collection of buttons.

checkBoxes

CheckBoxes

readonly

A collection of checkboxes.

comboBoxes

ComboBoxes

readonly

A collection of comboboxes.

documentOffset

Number

readonly

The sequential number of the page within the document.

epstexts

EPSTexts EPSText

readonly

EPSTexts

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

formFields

FormFields FormField

readonly

A collection of form fields.

graphicLines

GraphicLines GraphicLine

readonly

A collection of graphic lines.

gridData

GridDataInformation

readonly

Default grid properties. Note: Applies to named, layout, and frame (story) grids.

groups

Groups Group

readonly

A collection of groups.

guides

Guides Guide

readonly

A collection of guides.

id

Number

readonly

The unique ID of the Page.

index

Number

readonly

The index of the Page within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

layoutRule

LayoutRuleOptions

LayoutRuleOptions.GUIDE_BASED

LayoutRuleOptions.OBJECT_BASED

LayoutRuleOptions.OFF

LayoutRuleOptions.PRESERVE_EXISTING

LayoutRuleOptions.RECENTER

LayoutRuleOptions.SCALE

LayoutRuleOptions.USE_MASTER

read/write

layout rule

listBoxes

ListBoxes

readonly

A collection of listboxes.

marginPreferences

MarginPreference

readonly

Margin preference settings.

masterPageItems

Array of PageItems

Array of Graphics Graphic

Array of Guides Guide

Array of Movies

Array of Sounds Sound

readonly

The items on a specified document page that originated on the applied master page and have not been overridden or detached. Can return: Array of PageItems, Guides, Graphics, Movies or Sounds.

masterPageTransform

TransformationMatrix

read/write

The transform applied to the master page before it is applied to Page.

multiStateObjects

MultiStateObjects MultiStateObject

readonly

A collection of multi-state objects.

name

String

readonly

The name of the Page.

optionalPage

Boolean

read/write

optional page for HTML5 pagination. Obsolete after CS6

ovals

Ovals Oval

readonly

A collection of ellipses.

pageColor

Array of 3 Reals (0 - 255)

PageColorOptions

PageColorOptions.NOTHING

PageColorOptions.USE_MASTER_COLOR

UIColors

read/write

The color label of the Page, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or PageColorOptions enumerator.

pageItems

PageItems PageItem

readonly

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.

parent

MasterSpread

Spread

readonly

The parent of the Page (a Spread or MasterSpread).

polygons

Polygons Polygon

readonly

A collection of polygons.

preferences

Preferences Preference

readonly

A collection of preferences objects.

properties

Object

read/write

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

radioButtons

RadioButtons RadioButton

readonly

A collection of radio buttons.

rectangles

Rectangles Rectangle

readonly

A collection of rectangles.

side

PageSideOptions

PageSideOptions.LEFT_HAND

PageSideOptions.RIGHT_HAND

PageSideOptions.SINGLE_SIDED

readonly

The side of the binding spine on which to place the page within the spread.

signatureFields

SignatureFields SignatureField

readonly

A collection of signature fields.

snapshotBlendingMode

SnapshotBlendingModes

SnapshotBlendingModes.FULL_SNAPSHOT_BLENDING

SnapshotBlendingModes.IGNORE_LAYOUT_SNAPSHOTS

SnapshotBlendingModes.LIMITED_SNAPSHOT_BLENDING

SnapshotBlendingModes.USE_NEAREST_SNAPSHOT

read/write

snapshot blending mode

splineItems

SplineItems SplineItem

readonly

The spline items collection.

tabOrder

Array of Buttons

Array of CheckBoxes

Array of ComboBoxes

Array of ListBoxes

Array of RadioButtons RadioButton

Array of TextBoxes

Array of SignatureFields SignatureField

read/write

The order in which the focus moves to different form fields in the PDF when the tab key is pressed. Can return: Array of Buttons, CheckBoxes, ComboBoxes, ListBoxes, RadioButtons, TextBoxes or SignatureFields.

textBoxes

TextBoxes

readonly

A collection of text boxes.

textFrames

TextFrames TextFrame

readonly

A collection of text frames.

typefiElementAnchors

TypefiElementAnchors TypefiElementAnchor

readonly

A list of Typefi element anchors

typefiSettings

TypefiPageSettings

readonly

Typefi specific settings to pages

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)

Varies contentPlace (pageItems:Array of PageItem, [linkPageItems:Boolean=Boolean], [linkStories:Boolean=Boolean], [mapStyles:Boolean=Boolean], placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean])

Duplicate an object and place it into the target.

Parameter

Type

Description

pageItems

Array of PageItem

One or more page items to place or load

linkPageItems

Boolean

Whether to link pageItems in content placer (if true it will override link stories value) (Optional)

(default: false)

linkStories

Boolean

Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional)

(default: false)

mapStyles

Boolean

Whether to map styles in content placer (Optional)

(default: false)

placePoint

Array of Number

Array of String

The point at which to place (Optional)

destinationLayer

Layer

The layer on which to place (Optional)

showingOptions

Boolean

Whether to display the link options dialog (Optional)

(default: false)

undefined deleteAllLayoutSnapshots ()

Delete all layout snapshots for this Page.

undefined deleteLayoutSnapshot ()

Delete the snapshot of the layout for the current Page size and shape.

undefined detach ()

Detaches an overridden master page item from the master page.

Page duplicate ([to:LocationOptions=LocationOptions], reference:Varies Page Spread)

Duplicates the page.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location at which to place the duplicate page relative to the reference object or within the document or spread. (Optional)

(default: LocationOptions.AT_END)

reference

Page

Spread

The reference object. Note: Required when the to value specifies before or after. Can accept: Page or Spread. (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

Page getElements ()

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

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter

Type

Description

key

String

The key.

value

String

The value.

Page move ([to:LocationOptions=LocationOptions], reference:Varies Page Spread, [binding:BindingOptions=BindingOptions])

Moves the page.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The new location of the page relative to the reference object or within the document or spread. (Optional)

(default: LocationOptions.AT_END)

reference

Page

Spread

The reference object. Note: Required when the to parameter value specifies before or after. Can accept: Page or Spread. (Optional)

binding

BindingOptions

BindingOptions.DEFAULT_VALUE

BindingOptions.LEFT_ALIGN

BindingOptions.RIGHT_ALIGN

The location of the binding spine in spreads. (Optional)

(default: BindingOptions.DEFAULT_VALUE)

Varies place (fileName:File, placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean], [autoflowing:Boolean=Boolean], withProperties:Object)

Places the file.

Parameter

Type

Description

fileName

File

The file to place

placePoint

Array of Number

Array of String

The point at which to place (Optional)

destinationLayer

Layer

The layer on which to place (Optional)

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

autoflowing

Boolean

Whether to autoflow placed text (Optional)

(default: false)

withProperties

Object

Initial values for properties of the placed object(s) (Optional)

Story placeAndLink (parentStory:Story, placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean])

Deprecated: Use contentPlace method. Original Description: Create a linked story and place it into the target.

Parameter

Type

Description

parentStory

Story

The story to place and link from.

placePoint

Array of Number

Array of String

The point at which to place (Optional)

destinationLayer

Layer

The layer on which to place (Optional)

showingOptions

Boolean

Whether to display the link options dialog (Optional)

(default: false)

PageItem placeXML (using:XMLElement, placePoint:Array of Number String, [autoflowing:Boolean=Boolean])

Places the XML element onto a page. If the place point is above an existing page item, place the XML element into the page item.

Parameter

Type

Description

using

XMLElement

The XML element to place.

placePoint

Array of Number

Array of String

The point at which to place the object, specified in the format [x, y].

autoflowing

Boolean

If true, autoflows placed text. (Optional)

(default: false)

undefined reframe (in:Varies CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, opposingCorners:Array of Varies)

Move the bounding box of the page item

Parameter

Type

Description

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

BoundsKind:BoundingBoxLimits

OrderedarraycontainingcoordinateSpace:CoordinateSpaces

The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.

opposingCorners

Array of Varies

Opposing corners of new bounding box in the given coordinate space

undefined remove ()

Deletes the Page.

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)

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined resize (in:Varies BoundingBoxLimits CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, by:ResizeMethods, values:Array of Varies Reals ResizeConstraintss CoordinateSpacess, [resizeIndividually:Boolean=Boolean], [consideringRulerUnits:Boolean=Boolean])

Resize the page item.

Parameter

Type

Description

in

BoundingBoxLimits

BoundingBoxLimits.GEOMETRIC_PATH_BOUNDS

BoundingBoxLimits.OUTER_STROKE_BOUNDS

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

BoundsKind:BoundingBoxLimits

OrderedarraycontainingcoordinateSpace:CoordinateSpaces

The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.

from

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

by

ResizeMethods

ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO

ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY

ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH

ResizeMethods.RESHAPING_AREA_TO_RATIO

ResizeMethods.RESHAPING_BORDER_TO_RATIO

How the current dimensions are affected by the given values

values

Array of Reals

Array of ResizeConstraintss ResizeConstraints

Array of CoordinateSpacess CoordinateSpaces

The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.

resizeIndividually

Boolean

If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional)

(default: true)

consideringRulerUnits

Boolean

If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

Varies resolve (location:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, in:CoordinateSpaces, [consideringRulerUnits:Boolean=Boolean])

Get the coordinates of the given location in the specified coordinate system.

Parameter

Type

Description

location

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use.

consideringRulerUnits

Boolean

If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

SelectionOptions.SET_KEY

The selection status of the Page in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

PageItem setContent (using:String, relativeBasePath:String)

Replaces the content of XML element with content imported from a file.

Parameter

Type

Description

using

String

The file path to the import file.

relativeBasePath

String

Base path used to resolve relative paths. (Optional)

undefined snapshotCurrentLayout ()

Create a snapshot of the layout for the current Page size and shape.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined transform (in:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, withMatrix:Array of Varies 6 Reals TransformationMatrix, replacingCurrent:Array of Varies MatrixContent enumerators MatrixContent LongInteger, [consideringRulerUnits:Boolean=Boolean])

Transform the page item.

Parameter

Type

Description

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use

from

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

withMatrix

Array of 6 Reals

TransformationMatrix

Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.

replacingCurrent

Array of MatrixContent enumerators

MatrixContent

MatrixContent.ROTATION_VALUE

MatrixContent.SCALE_VALUES

MatrixContent.SHEAR_VALUE

MatrixContent.TRANSLATION_VALUES

LongInteger

Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)

consideringRulerUnits

Boolean

If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

TransformationMatrix transformValuesOf (in:CoordinateSpaces)

Get the transformation values of the page item.

Parameter

Type

Description

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use

Object of

Bookmark.destination

LayoutWindow.activePage

FormField.parentPage

Button.parentPage

MultiStateObject.parentPage

CheckBox.parentPage

ComboBox.parentPage

ListBox.parentPage

RadioButton.parentPage

TextBox.parentPage

SignatureField.parentPage

Movie.parentPage

Sound.parentPage

PageItem.parentPage

Oval.parentPage

Rectangle.parentPage

GraphicLine.parentPage

Polygon.parentPage

Group.parentPage

Image.parentPage

EPS.parentPage

PDF.parentPage

WMF.parentPage

PICT.parentPage

Graphic.parentPage

Guide.parentPage

SplineItem.parentPage

EPSText.parentPage

ImportedPage.parentPage

MediaItem.parentPage

HtmlItem.parentPage

TextFrame.parentPage

EndnoteTextFrame.parentPage

HyperlinkPageDestination.destinationPage

Event.parent

EventListener.parent

GridDataInformation.parent

MarginPreference.parent

MutationEvent.parent

Preference.parent

TypefiElementAnchor.parent

TypefiPageSettings.parent

Section.pageStart

Return

Pages.add()

Page.duplicate()

Page.move()

Page.getElements()

Pages.anyItem()

Pages.everyItem()

Pages.nextItem()

Pages.previousItem()

Pages.itemByID()

Pages.item()

Pages.[]()

Pages.itemByName()

Pages.itemByRange()

Pages.firstItem()

Pages.lastItem()

Pages.middleItem()