Adobe InCopy CS6 (8.0) Object Model JS: Page

InCopy CS6

previous page next page

Class

Page

A page.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, removeEventListener, resolve, toSource, toSpecifier, 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	readonly	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 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.
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	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	readonly	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 MultiStateObject	readonly	A collection of multi-state objects.
name	string	readonly	The name of the Page.
optionalPage	bool	readonly	optional page for HTML5 pagination
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.
preferences	Preferences Preference	readonly	A collection of preferences objects.
properties	Object	r/w	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.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 SignatureField	readonly	A collection of signature fields.
snapshotBlendingMode	SnapshotBlendingModes: SnapshotBlendingModes.IGNORE_LAYOUT_SNAPSHOTS SnapshotBlendingModes.USE_NEAREST_SNAPSHOT SnapshotBlendingModes.LIMITED_SNAPSHOT_BLENDING SnapshotBlendingModes.FULL_SNAPSHOT_BLENDING	readonly	snapshot blending mode
splineItems	SplineItems SplineItem	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 TextFrame	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)

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.

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)

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

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

string toSpecifier ()
Retrieves the object specifier.

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.SPREAD_COORDINATES	The coordinate space to use