Page

A 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.
appliedMaster MasterSpread 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 TrapPreset r/w The trap preset applied to the page. Can also accept: String.
bounds Array of number readonly The bounds of the Page, in the format [y1, x1, y2, x2].
buttons Buttons readonly A collection of buttons.
documentOffset number readonly The sequential number of the page within the document.
formFields FormFields readonly A collection of form fields.
graphicLines GraphicLines readonly A collection of graphic lines.
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.
label string r/w A property that can be set to any string.
marginPreferences MarginPreference readonly Margin preference settings.
masterPageItems Array of any 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.
name string readonly The name of the Page.
ovals Ovals readonly A collection of ellipses.
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 any readonly The parent of the Page (a Spread, MasterSpread or Document).
polygons Polygons readonly A collection of polygons.
properties Object r/w A property that allows setting of several properties at the same time.
rectangles Rectangles readonly A collection of rectangles.
side PageSideOptions :
RIGHT_HAND
LEFT_HAND
SINGLE_SIDED		 readonly The side of the binding spine on which to place the page within the spread.
tabOrder Array of FormField r/w The order in which the focus moves to different form fields when the tab button is pressed.
textFrames TextFrames readonly A collection of text frames.

Methods

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

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

Parameter Type Description
to LocationOptions :
BEFORE
AFTER
AT_END
AT_BEGINNING
UNKNOWN		 The location at which to place the duplicate page relative to the reference object or within the document or spread. (Optional) (default: 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=AT_END][, reference: any][, binding: BindingOptions=DEFAULT_VALUE])
Moves the page.

Parameter Type Description
to LocationOptions :
BEFORE
AFTER
AT_END
AT_BEGINNING
UNKNOWN		 The new location of the page relative to the reference object or within the document or spread. (Optional) (default: 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 :
RIGHT_ALIGN
LEFT_ALIGN
DEFAULT_VALUE		 The location of the binding spine in spreads. (Optional) (default: DEFAULT_VALUE)

Array of any place (fileName: File[, placePoint: Array of number][, 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 number 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 new Page (Optional)

PageItem placeXML (using: XMLElement, placePoint: Array of number[, 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 number 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 remove ()
Deletes the Page.

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

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)

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

string toSpecifier ()
Retrieves the object specifier.

Element of:

HyperlinkPageDestination.destinationPage
LayoutWindow.activePage
Section.pageStart

Used in:

Button.override ( destinationPage: Page)
EPS.override ( destinationPage: Page)
FormField.override ( destinationPage: Page)
Graphic.override ( destinationPage: Page)
GraphicLine.override ( destinationPage: Page)
Group.override ( destinationPage: Page)
Guide.override ( destinationPage: Page)
HyperlinkExternalPageDestinations.add ( [destination: Page][, withProperties: Object])
HyperlinkPageDestinations.add ( [destination: Page][, withProperties: Object])
Image.override ( destinationPage: Page)
ImportedPage.override ( destinationPage: Page)
Movie.override ( destinationPage: Page)
Oval.override ( destinationPage: Page)
PageItem.override ( destinationPage: Page)
Pages.previousItem ( obj: Page)
Pages.nextItem ( obj: Page)
PDF.override ( destinationPage: Page)
PICT.override ( destinationPage: Page)
Polygon.override ( destinationPage: Page)
Rectangle.override ( destinationPage: Page)
Sections.add ( [reference: Page][, withProperties: Object])
Sound.override ( destinationPage: Page)
TextFrame.override ( destinationPage: Page)
WMF.override ( destinationPage: Page)

Returned by:

Page Page.duplicate ( [to: LocationOptions=AT_END][, reference: any] )
Array of Page Page.getElements ( )
Page Page.move ( [to: LocationOptions=AT_END][, reference: any][, binding: BindingOptions=DEFAULT_VALUE] )
Page Pages.add ( [at: LocationOptions=UNKNOWN][, reference: any][, withProperties: Object] )
Page Pages.anyItem ( )
Array of Page Pages.everyItem ( )
Page Pages.firstItem ( )
Page Pages.item ( index: any )
Page Pages.itemByID ( id: number )
Page Pages.itemByName ( name: string )
Array of Page Pages.itemByRange ( from: any, to: any )
Page Pages.lastItem ( )
Page Pages.middleItem ( )
Page Pages.nextItem ( obj: Page )
Page Pages.previousItem ( obj: Page )