Page

A page.

Go to Property Listing | Method Listing

Methods:

detach, duplicate, extractLabel, getElements, insertLabel, move, place, placeXML, remove, removeOverride, resolve, setContent, toSource, toSpecifier, transformValuesOf

Objects:

Boolean, Buttons, FormField, FormFields, Graphic, GraphicLines, Graphics, Groups, Guides, MarginPreference, MasterSpread, Movies, NothingEnum, Number, Object, Ovals, PageItem, PageItems, PageSideOptions, Polygons, Rectangles, Section, Sounds, String, TextFrames, TrapPreset,

Preferences:

MarginPreference

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.
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.
documentOffset	Number	readonly	The sequential number of the page within the document.
formFields	FormFields FormField	readonly	A collection of form fields.
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
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.
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.
name	String	readonly	The name of the Page.
ovals	Ovals Oval	readonly	A collection of ellipses.
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.
properties	Object	read/write	A property that allows setting of several properties at the same time.
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.
tabOrder	Array of FormField	read/write	The order in which the focus moves to different form fields in the PDF when the tab key is pressed.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.

Method Listing

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)

Parameter

Type

Description

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)

Parameter

Type

Description

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)

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)

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 remove ()

Deletes the Page.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

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

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.

CoordinateSpaces

CoordinateSpaces.INNER_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)

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)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

TransformationMatrix transformValuesOf (in:CoordinateSpaces)

Get the transformation values of the page item.

Parameter	Type	Description
in	CoordinateSpaces CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use

Parameter

Type

Description

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use