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
Event | EventListener | GridDataInformation | MarginPreference | MutationEvent | Preference

Properties

PropertyTypeAccessDescription
allGraphicsArray of Graphic readonlyLists all graphics contained by the Page.
allPageItemsArray of PageItem readonlyLists all page items contained by the Page.
appliedAlternateLayoutSection readonlyThe alternate layout section to which the page belongs.
appliedMasterMasterSpread
NothingEnum
r/wThe master spread applied to the Page. Can also accept: NothingEnum enumerator.
appliedSectionSection readonlyThe section to which the page belongs.
appliedTrapPresetString
TrapPreset
r/wThe trap preset applied to the page. Can also accept: String.
boundsArray of Measurement Unit (Number or String) readonlyThe bounds of the Page, in the format [y1, x1, y2, x2].
buttonsButtons readonlyA collection of buttons.
checkBoxesCheckBoxes readonlyA collection of checkboxes.
comboBoxesComboBoxes readonlyA collection of comboboxes.
documentOffsetnumber readonlyThe sequential number of the page within the document.
epstextsEPSTexts readonlyEPSTexts
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
formFieldsFormFields readonlyA collection of form fields.
graphicLinesGraphicLines readonlyA collection of graphic lines.
gridDataGridDataInformation readonlyDefault grid properties. Note: Applies to named, layout, and frame (story) grids.
groupsGroups readonlyA collection of groups.
guidesGuides readonlyA collection of guides.
idnumber readonlyThe unique ID of the Page.
indexnumber readonlyThe index of the Page within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
layoutRuleLayoutRuleOptions:
LayoutRuleOptions.OFF
LayoutRuleOptions.SCALE
LayoutRuleOptions.RECENTER
LayoutRuleOptions.GUIDE_BASED
LayoutRuleOptions.OBJECT_BASED
LayoutRuleOptions.USE_MASTER
LayoutRuleOptions.PRESERVE_EXISTING
r/wlayout rule
listBoxesListBoxes readonlyA collection of listboxes.
marginPreferencesMarginPreference readonlyMargin preference settings.
masterPageItemsArray of
Graphics
Guides
Movies
PageItems
Sounds
readonlyThe 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.
masterPageTransformTransformationMatrix r/wThe transform applied to the master page before it is applied to Page.
multiStateObjectsMultiStateObjects readonlyA collection of multi-state objects.
namestring readonlyThe name of the Page.
optionalPagebool r/woptional page for HTML5 pagination
ovalsOvals readonlyA collection of ellipses.
pageColor3 Reals (0 - 255)
PageColorOptions
UIColors
r/wThe 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.
pageItemsPageItems readonlyThe 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.
parentMasterSpread
Spread
readonlyThe parent of the Page (a Spread or MasterSpread).
polygonsPolygons readonlyA collection of polygons.
preferencesPreferences readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
radioButtonsRadioButtons readonlyA collection of radio buttons.
rectanglesRectangles readonlyA collection of rectangles.
sidePageSideOptions:
PageSideOptions.RIGHT_HAND
PageSideOptions.LEFT_HAND
PageSideOptions.SINGLE_SIDED
readonlyThe side of the binding spine on which to place the page within the spread.
signatureFieldsSignatureFields readonlyA collection of signature fields.
snapshotBlendingModeSnapshotBlendingModes:
SnapshotBlendingModes.IGNORE_LAYOUT_SNAPSHOTS
SnapshotBlendingModes.USE_NEAREST_SNAPSHOT
SnapshotBlendingModes.LIMITED_SNAPSHOT_BLENDING
SnapshotBlendingModes.FULL_SNAPSHOT_BLENDING
r/wsnapshot blending mode
splineItemsSplineItems readonlyThe spline items collection.
tabOrderArray of
Buttons
CheckBoxes
ComboBoxes
ListBoxes
RadioButtons
SignatureFields
TextBoxes
r/wThe 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.
textBoxesTextBoxes readonlyA collection of text boxes.
textFramesTextFrames readonlyA collection of text frames.

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
pageItemsArray of PageItemOne or more page items to place or load
linkPageItemsboolWhether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStoriesboolWhether 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)
mapStylesboolWhether to map styles in content placer (Optional) (default: false)
placePointArray of Measurement Unit (Number or String)The point at which to place (Optional)
destinationLayerLayerThe layer on which to place (Optional)
showingOptionsboolWhether 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.

ParameterTypeDescription
toLocationOptions:
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)
referencePage
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.

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Page move ([to: LocationOptions=LocationOptions.AT_END][, reference: varies][, binding: BindingOptions=BindingOptions.DEFAULT_VALUE])
Moves the page.

ParameterTypeDescription
toLocationOptions:
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)
referencePage
Spread
The reference object. Note: Required when the to parameter value specifies before or after. Can accept: Page or Spread. (Optional)
bindingBindingOptions:
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.

ParameterTypeDescription
fileNameFileThe file to place
placePointArray of Measurement Unit (Number or String)The point at which to place (Optional)
destinationLayerLayerThe layer on which to place (Optional)
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
autoflowingboolWhether to autoflow placed text (Optional) (default: false)
withPropertiesObjectInitial 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.

ParameterTypeDescription
parentStoryStoryThe story to place and link from.
placePointArray of Measurement Unit (Number or String)The point at which to place (Optional)
destinationLayerLayerThe layer on which to place (Optional)
showingOptionsboolWhether 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.

ParameterTypeDescription
usingXMLElementThe XML element to place.
placePointArray of Measurement Unit (Number or String)The point at which to place the object, specified in the format [x, y].
autoflowingboolIf true, autoflows placed text. (Optional) (default: false)

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

ParameterTypeDescription
inboundsKind: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.
opposingCornersArray 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
inBoundingBoxLimits
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.
fromAnchorPoint
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.
byResizeMethods:
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
valuesArray 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.
resizeIndividuallyboolIf 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)
consideringRulerUnitsboolIf 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.

ParameterTypeDescription
locationAnchorPoint
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.
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.PAGE_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use.
consideringRulerUnitsboolIf 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.

ParameterTypeDescription
existingSelectionSelectionOptions:
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.

ParameterTypeDescription
usingstringThe file path to the import file.
relativeBasePathstringBase 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.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.PAGE_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use
fromAnchorPoint
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.
withMatrixArray of 6 Reals
TransformationMatrix
Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrentArray 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)
consideringRulerUnitsboolIf 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.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.PAGE_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use

Element of

Bookmark.destination

Button.parentPage

CheckBox.parentPage

ComboBox.parentPage

EPS.parentPage

EPSText.parentPage

FormField.parentPage

Graphic.parentPage

GraphicLine.parentPage

Group.parentPage

Guide.parentPage

HtmlItem.parentPage

HyperlinkPageDestination.destinationPage

Image.parentPage

ImportedPage.parentPage

LayoutWindow.activePage

ListBox.parentPage

MarginPreference.parent

MediaItem.parentPage

Movie.parentPage

MultiStateObject.parentPage

Oval.parentPage

PDF.parentPage

PICT.parentPage

PageItem.parentPage

Polygon.parentPage

RadioButton.parentPage

Rectangle.parentPage

Section.pageStart

SignatureField.parentPage

Sound.parentPage

SplineItem.parentPage

TextBox.parentPage

TextFrame.parentPage

WMF.parentPage

Used in:

varies=any Button.override (destinationPage: Page)

varies=any CheckBox.override (destinationPage: Page)

varies=any ComboBox.override (destinationPage: Page)

varies=any EPS.override (destinationPage: Page)

varies=any EPSText.override (destinationPage: Page)

varies=any FormField.override (destinationPage: Page)

varies=any Graphic.override (destinationPage: Page)

varies=any GraphicLine.override (destinationPage: Page)

varies=any Group.override (destinationPage: Page)

varies=any Guide.override (destinationPage: Page)

varies=any HtmlItem.override (destinationPage: Page)

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.add ([destination: Page][, withProperties: Object])

HyperlinkPageDestination HyperlinkPageDestinations.add ([destination: Page][, withProperties: Object])

varies=any Image.override (destinationPage: Page)

varies=any ImportedPage.override (destinationPage: Page)

varies=any ListBox.override (destinationPage: Page)

varies=any MediaItem.override (destinationPage: Page)

varies=any Movie.override (destinationPage: Page)

varies=any MultiStateObject.override (destinationPage: Page)

varies=any Oval.override (destinationPage: Page)

varies=any PDF.override (destinationPage: Page)

varies=any PICT.override (destinationPage: Page)

varies=any PageItem.override (destinationPage: Page)

Page Pages.nextItem (obj: Page)

Page Pages.previousItem (obj: Page)

varies=any Polygon.override (destinationPage: Page)

varies=any RadioButton.override (destinationPage: Page)

varies=any Rectangle.override (destinationPage: Page)

Section Sections.add ([reference: Page][, withProperties: Object])

varies=any SignatureField.override (destinationPage: Page)

varies=any Sound.override (destinationPage: Page)

varies=any SplineItem.override (destinationPage: Page)

varies=any TextBox.override (destinationPage: Page)

varies=any TextFrame.override (destinationPage: Page)

varies=any WMF.override (destinationPage: Page)

Return

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

Array of Page Page.getElements ()

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

Page Pages.[] (index: number)

Page Pages.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])

Page Pages.anyItem ()

Array of Page Pages.everyItem ()

Page Pages.firstItem ()

Page Pages.item (index: varies)

Page Pages.itemByID (id: number)

Page Pages.itemByName (name: string)

Array of Page Pages.itemByRange (from: varies, to: varies)

Page Pages.lastItem ()

Page Pages.middleItem ()

Page Pages.nextItem (obj: Page)

Page Pages.previousItem (obj: Page)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index