Object

Page

A page.

Hierarchy

Page

3 preference objects

GridDataInformation | MarginPreference | Preference

Properties

Type	Access	Description
Graphic[]	readonly	Lists all graphics contained by the Page.
PageItem[]	readonly	Lists all page items contained by the Page.
Section	readonly	The alternate layout section to which the page belongs.
MasterSpread \| NothingEnum	read/write	The master spread applied to the Page. Can also accept: NothingEnum enumerator.
Section	readonly	The section to which the page belongs.
TrapPreset \| String	read/write	The trap preset applied to the page. Can also accept: String.
Number[] \| String[] unit	readonly	The bounds of the Page, in the format [y1, x1, y2, x2].
Buttons<Button>	readonly	A collection of buttons.
CheckBoxes<CheckBox>	readonly	A collection of checkboxes.
ComboBoxes<ComboBox>	readonly	A collection of comboboxes.
Number	readonly	The sequential number of the page within the document.
EPSTexts<EPSText>	readonly	EPSTexts
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
FormFields<FormField>	readonly	A collection of form fields.
GraphicLines<GraphicLine>	readonly	A collection of graphic lines.
GridDataInformation	readonly	Default grid properties. Note: Applies to named, layout, and frame (story) grids.
Groups<Group>	readonly	A collection of groups.
Guides<Guide>	readonly	A collection of guides.
Number	readonly	The unique ID of the Page.
Number	readonly	The index of the Page within its containing object.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
LayoutRuleOptions	read/write	layout rule
ListBoxes<ListBox>	readonly	A collection of listboxes.
MarginPreference	readonly	Margin preference settings.
PageItems[]<PageItem> \| Graphics[]<Graphic> \| Guides[]<Guide> \| Movies[]<Movie> \| 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.
TransformationMatrix	read/write	The transform applied to the master page before it is applied to Page.
MultiStateObjects<MultiStateObject>	readonly	A collection of multi-state objects.
String	readonly	The name of the Page.
Boolean	read/write	optional page for HTML5 pagination. Obsolete after CS6
Ovals<Oval>	readonly	A collection of ellipses.
3 Reals (0 - 255)[] \| PageColorOptions[] \| 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<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.
MasterSpread \| Spread	readonly	The parent of the Page (a Spread or MasterSpread).
Polygons<Polygon>	readonly	A collection of polygons.
Preferences<Preference>	readonly	A collection of preferences objects.
Object	read/write	A property that allows setting of several properties at the same time.
RadioButtons<RadioButton>	readonly	A collection of radio buttons.
Rectangles<Rectangle>	readonly	A collection of rectangles.
PageSideOptions	readonly	The side of the binding spine on which to place the page within the spread.
SignatureFields<SignatureField>	readonly	A collection of signature fields.
SnapshotBlendingModes	read/write	snapshot blending mode
SplineItems<SplineItem>	readonly	The spline items collection.
Buttons[]<Button> \| CheckBoxes[]<CheckBox> \| ComboBoxes[]<ComboBox> \| ListBoxes[]<ListBox> \| RadioButtons[]<RadioButton> \| TextBoxes[]<TextBox> \| 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<TextBox>	readonly	A collection of text boxes.
TextFrames<TextFrame>	readonly	A collection of text frames.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

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

captures? Boolean This parameter is obsolete.

→ void

Adjust the existing layout according to new page size, bleed and margin values. The first parameter is a plain object with key value pairs for properties affected. Permissible keys are width, height, bleedInside, bleedTop, bleedOutside, bleedBottom, leftMargin, topMargin, rightMargin, bottomMargin. The values can be specified as decimal numbers in units of Pt or as a string having a measurement value such as '1 in'. Not all properties need to be specified, only the values that need updation. Notice that when dealing with individual pages rather than the whole document, bleed changes has no effect. E.g. - app.activeDocument.adjustLayout({width:'600px', leftMargin: '1in'}), app.activeDocument.adjustLayout({rightMargin:'1in'}, app.activeDocument.spreads[0].pages), app.activeDocument.spreads[0].pages[0].adjustLayout({width:'400px', leftMargin: '10px'})

adoptTo Object Change values - see functin definition for details

affectedPages? Page[] The collection of Page objects to affect (optional). Has no effect if function is called from Page

→ Varies[]

Duplicate an object and place it into the target.

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

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)

mapStyles? Boolean Whether to map styles in content placer

placePoint? Number[] | String[] unit The point at which to place

destinationLayer? Layer The layer on which to place

showingOptions? Boolean Whether to display the link options dialog

→ void

Delete all layout snapshots for this Page.

→ void

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

→ void

Detaches an overridden master page item from the master page.

→ Page

Duplicates the page.

to? LocationOptions The location at which to place the duplicate page relative to the reference object or within the document or spread.

reference? Page | Spread The reference object. Note: Required when the to value specifies before or after. Can accept: Page or Spread.

→ String

Gets the label value associated with the specified key.

key String The key.

→ Page[]

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

→ void

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

key String The key.

value String The value.

→ Page

Moves the page.

to? LocationOptions The new location of the page relative to the reference object or within the document or spread.

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

binding? BindingOptions The location of the binding spine in spreads.

→ Varies[]

Places the file.

fileName File The file to place

placePoint? Number[] | String[] unit The point at which to place

destinationLayer? Layer The layer on which to place

autoflowing? Boolean Whether to autoflow placed text

withProperties? Object Initial values for properties of the placed object(s)

→ Story

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

parentStory Story The story to place and link from.

placePoint? Number[] | String[] unit The point at which to place

destinationLayer? Layer The layer on which to place

showingOptions? Boolean Whether to display the link options dialog

→ PageItem

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.

using XMLElement The XML element to place.

placePoint Number[] | String[] unit The point at which to place the object, specified in the format [x, y].

autoflowing? Boolean If true, autoflows placed text.

→ void

Move the bounding box of the page item

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

opposingCorners Varies[] Opposing corners of new bounding box in the given coordinate space

→ void

Deletes the Page.

→ Boolean

Removes the event listener.

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.

→ void

Removes the override from a previously overridden master page item.

→ void

Resize the page item.

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

from AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | 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 How the current dimensions are affected by the given values

values Reals[] | ResizeConstraintss[] | CoordinateSpacess[] 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.

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.

→ Varies

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

location AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | 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 The coordinate space to use.

→ PageItem

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

using String The file path to the import file.

relativeBasePath? String Base path used to resolve relative paths.

→ void

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

→ String

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

→ String

Retrieves the object specifier.

→ void

Transform the page item.

in CoordinateSpaces The coordinate space to use

from AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | 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 6 Reals[] | TransformationMatrix[] Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.

replacingCurrent? MatrixContent enumerators[] | MatrixContent[] | 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.

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.

→ TransformationMatrix[]

Get the transformation values of the page item.

in CoordinateSpaces The coordinate space to use

Object of 41

Properties elsewhere that hold a Page.

Parameter of 129

Method parameters that accept a Page.

Return 16

Methods that return a Page.

Page.duplicate()Page.getElements()Page.move()Pages.[]()Pages.add()Pages.anyItem()Pages.everyItem()Pages.firstItem()Pages.item()Pages.itemByID()Pages.itemByName()Pages.itemByRange()Pages.lastItem()Pages.middleItem()Pages.nextItem()Pages.previousItem()