Page
A page.
Go to Property Listing | Method Listing
Methods:
addEventListener, adjustLayout, 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
Objects:
Boolean, Buttons, CheckBoxes, ComboBoxes, EPSTexts, EventListeners, Events, FormFields, Graphic, GraphicLines, Graphics, GridDataInformation, Groups, Guides, LayoutRuleOptions, ListBoxes, MarginPreference, MasterSpread, Movies, MultiStateObjects, NothingEnum, Number, Object, Ovals, PageColorOptions, PageItem, PageItems, PageSideOptions, Polygons, Preferences, RadioButtons, Rectangles, Section, SignatureFields, SnapshotBlendingModes, Sounds, SplineItems, String, TextBoxes, TextFrames, TransformationMatrix, TrapPreset, UIColors,
Preferences:
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
Lists all graphics contained by the Page. |
||
|
readonly |
Lists all page items contained by the Page. |
||
|
readonly |
The alternate layout section to which the page belongs. |
||
|
read/write |
The master spread applied to the Page. Can also accept: NothingEnum enumerator. |
||
|
readonly |
The section to which the page belongs. |
||
|
read/write |
The trap preset applied to the page. Can also accept: String. |
||
|
readonly |
The bounds of the Page, in the format [y1, x1, y2, x2]. |
||
|
readonly |
A collection of buttons. |
||
|
readonly |
A collection of checkboxes. |
||
|
readonly |
A collection of comboboxes. |
||
|
readonly |
The sequential number of the page within the document. |
||
|
readonly |
EPSTexts |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
A collection of form fields. |
||
|
readonly |
A collection of graphic lines. |
||
|
readonly |
Default grid properties. Note: Applies to named, layout, and frame (story) grids. |
||
|
readonly |
A collection of groups. |
||
|
readonly |
A collection of guides. |
||
|
readonly |
The unique ID of the Page. |
||
|
readonly |
The index of the Page within its containing object. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
layout rule |
||
|
readonly |
A collection of listboxes. |
||
|
readonly |
Margin preference settings. |
||
|
Array of PageItems |
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. |
|
|
read/write |
The transform applied to the master page before it is applied to Page. |
||
|
readonly |
A collection of multi-state objects. |
||
|
readonly |
The name of the Page. |
||
|
read/write |
optional page for HTML5 pagination. Obsolete after CS6 |
||
|
readonly |
A collection of ellipses. |
||
|
Array of 3 Reals (0 - 255) |
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. |
|
|
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. |
||
|
readonly |
The parent of the Page (a Spread or MasterSpread). |
||
|
readonly |
A collection of polygons. |
||
|
readonly |
A collection of preferences objects. |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
A collection of radio buttons. |
||
|
readonly |
A collection of rectangles. |
||
|
readonly |
The side of the binding spine on which to place the page within the spread. |
||
|
readonly |
A collection of signature fields. |
||
|
read/write |
snapshot blending mode |
||
|
readonly |
The spline items collection. |
||
|
Array of Buttons Array of CheckBoxes Array of ComboBoxes |
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. |
|
|
readonly |
A collection of text boxes. |
||
|
readonly |
A collection of text frames. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined adjustLayout (adoptTo:Object, affectedPages:Array of Page)
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'})
|
Parameter |
Type |
Description |
|---|---|---|
|
adoptTo |
Change values - see functin definition for details |
|
|
affectedPages |
The collection of Page objects to affect (optional). Has no effect if function is called from Page (Optional) |
Varies contentPlace (pageItems:Array of PageItem, [linkPageItems:Boolean=Boolean], [linkStories:Boolean=Boolean], [mapStyles:Boolean=Boolean], placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean])
Duplicate an object and place it into the target.
|
Parameter |
Type |
Description |
|---|---|---|
|
pageItems |
One or more page items to place or load |
|
|
linkPageItems |
Whether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false) |
|
|
linkStories |
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 |
Whether to map styles in content placer (Optional) (default: false) |
|
|
placePoint |
The point at which to place (Optional) |
|
|
destinationLayer |
The layer on which to place (Optional) |
|
|
showingOptions |
Whether to display the link options dialog (Optional) (default: false) |
undefined deleteAllLayoutSnapshots ()
Delete all layout snapshots for this Page.
undefined deleteLayoutSnapshot ()
Delete the snapshot of the layout for the current Page size and shape.
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 |
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 |
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 |
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.
Page move ([to:LocationOptions=LocationOptions], reference:Varies Page Spread, [binding:BindingOptions=BindingOptions])
Moves the page.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The new location of the page relative to the reference object or within the document or spread. (Optional) (default: LocationOptions.AT_END) |
|
|
reference |
The reference object. Note: Required when the to parameter value specifies before or after. Can accept: Page or Spread. (Optional) |
|
|
binding |
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 |
The file to place |
|
|
placePoint |
The point at which to place (Optional) |
|
|
destinationLayer |
The layer on which to place (Optional) |
|
|
showingOptions |
Whether to display the import options dialog (Optional) (default: false) |
|
|
autoflowing |
Whether to autoflow placed text (Optional) (default: false) |
|
|
withProperties |
Initial values for properties of the placed object(s) (Optional) |
Story placeAndLink (parentStory:Story, placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean])
Deprecated: Use contentPlace method. Original Description: Create a linked story and place it into the target.
|
Parameter |
Type |
Description |
|---|---|---|
|
parentStory |
The story to place and link from. |
|
|
placePoint |
The point at which to place (Optional) |
|
|
destinationLayer |
The layer on which to place (Optional) |
|
|
showingOptions |
Whether to display the link options dialog (Optional) (default: false) |
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 |
The XML element to place. |
|
|
placePoint |
The point at which to place the object, specified in the format [x, y]. |
|
|
autoflowing |
If true, autoflows placed text. (Optional) (default: false) |
undefined reframe (in:Varies CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, opposingCorners:Array of Varies)
Move the bounding box of the page item
|
Parameter |
Type |
Description |
|---|---|---|
|
in |
BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces |
The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
|
opposingCorners |
Array of Varies |
Opposing corners of new bounding box in the given coordinate space |
undefined remove ()
Deletes the Page.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined removeOverride ()
Removes the override from a previously overridden master page item.
undefined resize (in:Varies BoundingBoxLimits CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, by:ResizeMethods, values:Array of Varies Reals ResizeConstraintss CoordinateSpacess, [resizeIndividually:Boolean=Boolean], [consideringRulerUnits:Boolean=Boolean])
Resize the page item.
|
Parameter |
Type |
Description |
|---|---|---|
|
in |
BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces |
The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
|
from |
AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of 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 |
How the current dimensions are affected by the given values |
|
|
values |
Array of Reals Array of ResizeConstraintss ResizeConstraints Array of CoordinateSpacess CoordinateSpaces |
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 |
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 |
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) |
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 |
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 |
The coordinate space to use. |
|
|
consideringRulerUnits |
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) |
undefined select ([existingSelection:SelectionOptions=SelectionOptions])
Selects the object.
|
Parameter |
Type |
Description |
|---|---|---|
|
existingSelection |
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 |
The file path to the import file. |
|
|
relativeBasePath |
Base path used to resolve relative paths. (Optional) |
undefined 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.
undefined transform (in:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, withMatrix:Array of Varies 6 Reals TransformationMatrix, replacingCurrent:Array of Varies MatrixContent enumerators MatrixContent LongInteger, [consideringRulerUnits:Boolean=Boolean])
Transform the page item.
|
Parameter |
Type |
Description |
|---|---|---|
|
in |
The coordinate space to use |
|
|
from |
AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of 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 |
Array of 6 Reals |
Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. |
|
replacingCurrent |
Array of MatrixContent enumerators 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. (Optional) |
|
consideringRulerUnits |
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) |
TransformationMatrix transformValuesOf (in:CoordinateSpaces)
Get the transformation values of the page item.
|
Parameter |
Type |
Description |
|---|---|---|
|
in |
The coordinate space to use |
Object of
Bookmark.destination
LayoutWindow.activePage
FormField.parentPage
Button.parentPage
MultiStateObject.parentPage
CheckBox.parentPage
ComboBox.parentPage
ListBox.parentPage
RadioButton.parentPage
TextBox.parentPage
SignatureField.parentPage
Movie.parentPage
Sound.parentPage
PageItem.parentPage
Oval.parentPage
Rectangle.parentPage
GraphicLine.parentPage
Polygon.parentPage
Group.parentPage
Image.parentPage
EPS.parentPage
PDF.parentPage
WMF.parentPage
PICT.parentPage
Graphic.parentPage
Guide.parentPage
SplineItem.parentPage
EPSText.parentPage
ImportedPage.parentPage
SVG.parentPage
MediaItem.parentPage
HtmlItem.parentPage
TextFrame.parentPage
EndnoteTextFrame.parentPage
HyperlinkPageDestination.destinationPage
Event.parent
EventListener.parent
GridDataInformation.parent
MarginPreference.parent
MutationEvent.parent
Preference.parent
Section.pageStart