Adobe InDesign CS6 (8.0) Object Model JS: Page

InDesign CS6

previous page next page

Class

Page

A page.

QuickLinks

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

Hierarchy

MasterSpread | Spread

Page

Properties

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	r/w	The master spread applied to the Page. Can also accept: NothingEnum enumerator.
appliedSection	Section	readonly	The section to which the page belongs.
appliedTrapPreset	String TrapPreset	r/w	The trap preset applied to the page. Can also accept: String.
bounds	Array of Measurement Unit (Number or String)	readonly	The bounds of the Page, in the format [y1, x1, y2, x2].
buttons	Buttons	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	readonly	EPSTexts
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
formFields	FormFields	readonly	A collection of form fields.
graphicLines	GraphicLines	readonly	A collection of graphic lines.
gridData	GridDataInformation	readonly	Default grid properties. Note: Applies to named, layout, and frame (story) grids.
groups	Groups	readonly	A collection of groups.
guides	Guides	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	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
layoutRule	LayoutRuleOptions: LayoutRuleOptions.OFF LayoutRuleOptions.SCALE LayoutRuleOptions.RECENTER LayoutRuleOptions.GUIDE_BASED LayoutRuleOptions.OBJECT_BASED LayoutRuleOptions.USE_MASTER LayoutRuleOptions.PRESERVE_EXISTING	r/w	layout rule
listBoxes	ListBoxes	readonly	A collection of listboxes.
marginPreferences	MarginPreference	readonly	Margin preference settings.
masterPageItems	Array of Graphics Guides Movies PageItems Sounds	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	r/w	The transform applied to the master page before it is applied to Page.
multiStateObjects	MultiStateObjects	readonly	A collection of multi-state objects.
name	string	readonly	The name of the Page.
optionalPage	bool	r/w	optional page for HTML5 pagination
ovals	Ovals	readonly	A collection of ellipses.
pageColor	3 Reals (0 - 255) PageColorOptions UIColors	r/w	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	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	readonly	A collection of polygons.
preferences	Preferences	readonly	A collection of preferences objects.
properties	Object	r/w	A property that allows setting of several properties at the same time.
radioButtons	RadioButtons	readonly	A collection of radio buttons.
rectangles	Rectangles	readonly	A collection of rectangles.
side	PageSideOptions: PageSideOptions.RIGHT_HAND PageSideOptions.LEFT_HAND PageSideOptions.SINGLE_SIDED	readonly	The side of the binding spine on which to place the page within the spread.
signatureFields	SignatureFields	readonly	A collection of signature fields.
snapshotBlendingMode	SnapshotBlendingModes: SnapshotBlendingModes.IGNORE_LAYOUT_SNAPSHOTS SnapshotBlendingModes.USE_NEAREST_SNAPSHOT SnapshotBlendingModes.LIMITED_SNAPSHOT_BLENDING SnapshotBlendingModes.FULL_SNAPSHOT_BLENDING	r/w	snapshot blending mode
splineItems	SplineItems	readonly	The spline items collection.
tabOrder	Array of Buttons CheckBoxes ComboBoxes ListBoxes RadioButtons SignatureFields TextBoxes	r/w	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	readonly	A collection of text frames.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of any contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false])
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	bool	Whether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStories	bool	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	bool	Whether to map styles in content placer (Optional) (default: false)
placePoint	Array of Measurement Unit (Number or String)	The point at which to place (Optional)
destinationLayer	Layer	The layer on which to place (Optional)
showingOptions	bool	Whether to display the link options dialog (Optional) (default: false)

void deleteAllLayoutSnapshots ()
Delete all layout snapshots for this Page.

void deleteLayoutSnapshot ()
Delete the snapshot of the layout for the current Page size and shape.

void detach ()
Detaches an overridden master page item from the master page.

Page duplicate ([to: LocationOptions=LocationOptions.AT_END][, reference: varies])
Duplicates the page.

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING 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.

Array of Page getElements ()
Resolves the object specifier, creating an array of object references.

void 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.AT_END][, reference: varies][, binding: BindingOptions=BindingOptions.DEFAULT_VALUE])
Moves the page.

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING 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.RIGHT_ALIGN BindingOptions.LEFT_ALIGN BindingOptions.DEFAULT_VALUE	The location of the binding spine in spreads. (Optional) (default: BindingOptions.DEFAULT_VALUE)

Array of any place (fileName: File[, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false][, autoflowing: bool=false][, withProperties: Object])
Places the file.

Parameter	Type	Description
fileName	File	The file to place
placePoint	Array of Measurement Unit (Number or String)	The point at which to place (Optional)
destinationLayer	Layer	The layer on which to place (Optional)
showingOptions	bool	Whether to display the import options dialog (Optional) (default: false)
autoflowing	bool	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 Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false])
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 Measurement Unit (Number or String)	The point at which to place (Optional)
destinationLayer	Layer	The layer on which to place (Optional)
showingOptions	bool	Whether to display the link options dialog (Optional) (default: false)

PageItem placeXML (using: XMLElement, placePoint: Array of Measurement Unit (Number or String)[, autoflowing: bool=false])
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 Measurement Unit (Number or String)	The point at which to place the object, specified in the format [x, y].
autoflowing	bool	If true, autoflows placed text. (Optional) (default: false)

void reframe (in: varies, opposingCorners: Array of varies)
Move the bounding box of the page item

Parameter	Type	Description
in	boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
opposingCorners	Array of any	Opposing corners of new bounding box in the given coordinate space

void remove ()
Deletes the Page.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void removeOverride ()
Removes the override from a previously overridden master page item.

void resize (in: varies, from: varies, by: ResizeMethods, values: Array of varies[, resizeIndividually: bool=true][, consideringRulerUnits: bool=false])
Resize the page item.

Parameter	Type	Description
in	BoundingBoxLimits boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace: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 Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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 : Array of Reals CoordinateSpaces ResizeConstraints	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	bool	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	bool	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)

any resolve (location: varies, in: CoordinateSpaces[, consideringRulerUnits: bool=false])
Get the coordinates of the given location in the specified coordinate system.

Parameter	Type	Description
location	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use.
consideringRulerUnits	bool	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)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
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)

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

void transform (in: CoordinateSpaces, from: varies, withMatrix: varies[, replacingCurrent: varies][, consideringRulerUnits: bool=false])
Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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 Long Integer MatrixContent	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	bool	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)

Array of TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

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