Class: Page | K4 InDesign Javascript API Documentation

A page.

Instance Properties

Name	Description	Access
allGraphics	Graphic Lists all graphics contained by the Page.	read-only
allPageItems	PageItem Lists all page items contained by the Page.	read-only
appliedAlternateLayout	Section The alternate layout section to which the page belongs.	read-only
appliedMaster	MasterSpread The master spread applied to the Page. Can also accept: NothingEnum enumerator.	read-write
appliedSection	Section The section to which the page belongs.	read-only
appliedTrapPreset	TrapPreset The trap preset applied to the page. Can also accept: String.	read-write
bounds	Measurement Unit (Number or String)=any The bounds of the Page, in the format [y1, x1, y2, x2].	read-only
buttons	Buttons A collection of buttons.	read-only
checkBoxes	CheckBoxes A collection of checkboxes.	read-only
comboBoxes	ComboBoxes A collection of comboboxes.	read-only
documentOffset	number The sequential number of the page within the document.	read-only
epstexts	EPSTexts EPSTexts	read-only
eventListeners	EventListeners A collection of event listeners.	read-only
events	Events A collection of events.	read-only
formFields	FormFields A collection of form fields.	read-only
graphicLines	GraphicLines A collection of graphic lines.	read-only
gridData	GridDataInformation Default grid properties. Note: Applies to named, layout, and frame (story) grids.	read-only
groups	Groups A collection of groups.	read-only
guides	Guides A collection of guides.	read-only
id	number The unique ID of the Page.	read-only
index	number The index of the Page within its containing object.	read-only
isValid	bool Returns true if the object specifier resolves to valid objects.	read-only
label	string A property that can be set to any string.	read-write
layoutRule	LayoutRuleOptions layout rule	read-write
listBoxes	ListBoxes A collection of listboxes.	read-only
marginPreferences	MarginPreference Margin preference settings.	read-only
masterPageItems	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.	read-only
masterPageTransform	TransformationMatrix The transform applied to the master page before it is applied to Page.	read-write
multiStateObjects	MultiStateObjects A collection of multi-state objects.	read-only
name	string The name of the Page.	read-only
optionalPage	bool optional page for HTML5 pagination. Obsolete after CS6	read-write
ovals	Ovals A collection of ellipses.	read-only
pageColor	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.	read-write
pageItems	PageItems 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.	read-only
parent	The parent of the Page (a Spread or MasterSpread).	read-only
polygons	Polygons A collection of polygons.	read-only
preferences	Preferences A collection of preferences objects.	read-only
properties	Object A property that allows setting of several properties at the same time.	read-write
radioButtons	RadioButtons A collection of radio buttons.	read-only
rectangles	Rectangles A collection of rectangles.	read-only
side	PageSideOptions The side of the binding spine on which to place the page within the spread.	read-only
signatureFields	SignatureFields A collection of signature fields.	read-only
snapshotBlendingMode	SnapshotBlendingModes snapshot blending mode	read-write
splineItems	SplineItems The spline items collection.	read-only
tabOrder	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.	read-write
textBoxes	TextBoxes A collection of text boxes.	read-only
textFrames	TextFrames A collection of text frames.	read-only

Methods

addEventListener(

eventType, handler [, captures])

→ EventListener

contentPlace(

pageItems [, linkPageItems] [, linkStories] [, mapStyles] [, placePoint] [, destinationLayer] [, showingOptions])

deleteAllLayoutSnapshots(

)

deleteLayoutSnapshot(

)

detach(

)

duplicate(

[to], reference)

→ Page

extractLabel(

key)

→ string

getElements(

)

→ Page

insertLabel(

key, value)

move(

[to], reference [, binding])

→ Page

place(

fileName [, placePoint] [, destinationLayer] [, showingOptions] [, autoflowing] [, withProperties])

placeAndLink(

parentStory [, placePoint] [, destinationLayer] [, showingOptions])

→ Story

placeXML(

using, placePoint [, autoflowing])

→ PageItem

reframe(

in, opposingCorners)

remove(

)

removeEventListener(

eventType, handler [, captures])

→ bool

removeOverride(

)

resize(

in, from, by, values [, resizeIndividually] [, consideringRulerUnits])

resolve(

location, in [, consideringRulerUnits])

select(

[existingSelection])

setContent(

using [, relativeBasePath])

→ PageItem

snapshotCurrentLayout(

)

toSource(

)

→ string

toSpecifier(

)

→ string

transform(

in, from, withMatrix, replacingCurrent [, consideringRulerUnits])

transformValuesOf(

in)

→ TransformationMatrix

addEventListener( eventType, handler [, captures=false]) → EventListener

Adds an event listener.

`eventType`	string The event type.
`handler`	The event handler. Can accept: File or JavaScript Function.
`captures`	bool This parameter is obsolete. (Optional)

contentPlace( pageItems [, linkPageItems=false] [, linkStories=false] [, mapStyles=false] [, placePoint] [, destinationLayer] [, showingOptions=false])

Duplicate an object and place it into the target.

`pageItems`	Array<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)
`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)
`mapStyles`	bool Whether to map styles in content placer (Optional)
`placePoint`	Array<Measurement Unit (Number or String)=any> 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)

deleteAllLayoutSnapshots( )

Delete all layout snapshots for this Page.

deleteLayoutSnapshot( )

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

detach( )

Detaches an overridden master page item from the master page.

duplicate( [to=LocationOptions.AT_END], reference) → 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. (Optional)
`reference`	The reference object. Note: Required when the to value specifies before or after. Can accept: Page or Spread. (Optional)

extractLabel( key) → string

Gets the label value associated with the specified key.

key string The key.

getElements( ) → Page

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

insertLabel( key, value)

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

`key`	string The key.
`value`	string The value.

move( [to=LocationOptions.AT_END], reference [, binding=BindingOptions.DEFAULT_VALUE]) → Page

Moves the page.

`to`	LocationOptions The new location of the page relative to the reference object or within the document or spread. (Optional)
`reference`	The reference object. Note: Required when the to parameter value specifies before or after. Can accept: Page or Spread. (Optional)
`binding`	BindingOptions The location of the binding spine in spreads. (Optional)

place( fileName [, placePoint] [, destinationLayer] [, showingOptions=false] [, autoflowing=false] [, withProperties])

Places the file.

`fileName`	File The file to place
`placePoint`	Array<Measurement Unit (Number or String)=any> 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)
`autoflowing`	bool Whether to autoflow placed text (Optional)
`withProperties`	Object Initial values for properties of the placed object(s) (Optional)

placeAndLink( parentStory [, placePoint] [, destinationLayer] [, showingOptions=false]) → 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`	Array<Measurement Unit (Number or String)=any> 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)

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

reframe( in, opposingCorners)

Move the bounding box of the page item

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

remove( )

Deletes the Page.

removeEventListener( eventType, handler [, captures=false]) → bool

Removes the event listener.

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

removeOverride( )

Removes the override from a previously overridden master page item.

resize( in, from, by, values [, resizeIndividually=true] [, consideringRulerUnits=false])

Resize the page item.

`in`	The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
`from`	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`	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)
`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)

resolve( location, in [, consideringRulerUnits=false])

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

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

select( [existingSelection=SelectionOptions.REPLACE_WITH])

Selects the object.

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

setContent( using [, relativeBasePath]) → 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. (Optional)

snapshotCurrentLayout( )

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

toSource( ) → string

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

toSpecifier( ) → string

Retrieves the object specifier.

transform( in, from, withMatrix, replacingCurrent [, consideringRulerUnits=false])

Transform the page item.

`in`	CoordinateSpaces The coordinate space to use
`from`	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`	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
`replacingCurrent`	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)

transformValuesOf( in) → TransformationMatrix

Get the transformation values of the page item.

`in`	CoordinateSpaces The coordinate space to use