Class

PageItem

 

An item on a page, including rectangles, ellipses, graphic lines, polygons, groups, text frames, and buttons.

Superclass of EPSText, FormField, Graphic, Group, MediaItem, SplineItem, and TextFrame

QuickLinks

addEventListener, applyObjectStyle, asynchronousExportFile, autoTag, changeObject, clearObjectStyleOverrides, clearTransformations, convertShape, detach, duplicate, exportFile, extractLabel, findObject, fit, flipItem, getElements, insertLabel, markup, move, override, place, placeXML, redefineScaling, reframe, remove, removeEventListener, removeOverride, resize, resolve, select, store, toSource, toSpecifier, transform, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually, transformValuesOf

Hierarchy

Character | GraphicLine | Group | MasterSpread | Movie | Oval | PlaceGun | Polygon | Rectangle | Snippet | Sound | SplineItem | Spread | State | XMLElement
PageItem
EPSText | FormField | Graphic | Group | MediaItem | SplineItem | TextFrame
AnimationSetting | ContentTransparencySetting | Event | EventListener | FillTransparencySetting | MutationEvent | Preference | StrokeTransparencySetting | TextWrapPreference | TimingSetting | TransparencySetting

Properties

PropertyTypeAccessDescription
absoluteFlipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wIndicates whether the PageItem has been flipped independently of its parent object and, if yes, the direction in which the PageItem was flipped.
absoluteHorizontalScalenumber r/wThe horizontal scale of the PageItem relative to its containing object.
absoluteRotationAnglenumber r/wThe rotation angle of the PageItem relative to its containing object. (Range: -360 to 360)
absoluteShearAnglenumber r/wThe skewing angle of the PageItem relative to its containing object. (Range: -360 to 360)
absoluteVerticalScalenumber r/wThe vertical scale of the PageItem relative to its containing object.
allArticles Array of Article readonlyThe list of all articles this page item is part of
allGraphics Array of Graphic readonlyLists all graphics contained by the PageItem.
allPageItems Array of PageItem readonlyLists all page items contained by the PageItem.
allowOverridesbool r/wIf true, the master page item can be overridden.
animationSettingsAnimationSetting readonlyThe page item animation settings.
appliedObjectStyleObjectStyle r/wThe object style applied to the PageItem.
associatedXMLElementXMLItem readonlyThe XML element associated with the PageItem.
bottomLeftCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe shape to apply to the bottom left corner of rectangular shapes.
bottomLeftCornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
bottomRightCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe shape to apply to the bottom right corner of rectangular shapes.
bottomRightCornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
contentTransparencySettingsContentTransparencySetting readonlyTransparency settings for the content of the PageItem.
endCapEndCap:
EndCap.BUTT_END_CAP
EndCap.ROUND_END_CAP
EndCap.PROJECTING_END_CAP
r/wThe end shape of an open path.
endJoinEndJoin:
EndJoin.MITER_END_JOIN
EndJoin.ROUND_END_JOIN
EndJoin.BEVEL_END_JOIN
r/wThe corner join applied to the PageItem.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItem. . Can also accept: String.
fillTintnumber r/wThe percent of tint to use in the PageItem's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
fillTransparencySettingsFillTransparencySetting readonlyTransparency settings for the fill applied to the PageItem.
flipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wThe direction in which to flip the printed image.
gapColorSwatch r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTintnumber r/wThe tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
geometricBounds Array of Measurement Unit (Number or String) r/wThe bounds of the PageItem excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
gradientFillAnglenumber r/wThe angle of a linear gradient applied to the fill of the PageItem. (Range: -180 to 180)
gradientFillLengthMeasurement Unit (Number or String) r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the PageItem.
gradientFillStart Array of Measurement Unit (Number or String) r/wThe starting point (in page coordinates) of a gradient applied to the fill of the PageItem, in the format [x, y].
gradientStrokeAnglenumber r/wThe angle of a linear gradient applied to the stroke of the PageItem. (Range: -180 to 180)
gradientStrokeLengthMeasurement Unit (Number or String) r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the PageItem.
gradientStrokeStart Array of Measurement Unit (Number or String) r/wThe starting point (in page coordinates) of a gradient applied to the stroke of the PageItem, in the format [x, y].
horizontalScalenumber r/wThe horizontal scaling applied to the PageItem.
idnumber readonlyThe unique ID of the PageItem.
indexnumber readonlyThe index of the PageItem within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
itemLayerLayer r/wThe layer that the PageItem is on.
labelstring r/wA property that can be set to any string.
leftLineEndArrowHead:
ArrowHead.NONE
ArrowHead.SIMPLE_ARROW_HEAD
ArrowHead.SIMPLE_WIDE_ARROW_HEAD
ArrowHead.TRIANGLE_ARROW_HEAD
ArrowHead.TRIANGLE_WIDE_ARROW_HEAD
ArrowHead.BARBED_ARROW_HEAD
ArrowHead.CURVED_ARROW_HEAD
ArrowHead.CIRCLE_ARROW_HEAD
ArrowHead.CIRCLE_SOLID_ARROW_HEAD
ArrowHead.SQUARE_ARROW_HEAD
ArrowHead.SQUARE_SOLID_ARROW_HEAD
ArrowHead.BAR_ARROW_HEAD
r/wThe arrowhead applied to the start of the path.
localDisplaySettingDisplaySettingOptions:
DisplaySettingOptions.HIGH_QUALITY
DisplaySettingOptions.TYPICAL
DisplaySettingOptions.OPTIMIZED
DisplaySettingOptions.DEFAULT_VALUE
r/wDisplay performance options for the PageItem.
lockedbool r/wIf true, the PageItem is locked.
miterLimitnumber (range: 1 - 500) r/wThe limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4)
namestring r/wThe name of the PageItem.
nonprintingbool r/wIf true, the PageItem does not print.
overprintFillbool r/wIf true, the PageItem's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGapbool r/wIf true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStrokebool r/wIf true, the PageItem's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overriddenbool readonlyIf true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItemGraphic
Guide
Movie
PageItem
Sound
readonlyAn object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parentCharacter
GraphicLine
Group
MasterSpread
Movie
Oval
PlaceGun
Polygon
Rectangle
Snippet
Sound
SplineItem
Spread
State
XMLElement
readonlyThe parent of the PageItem (a XMLElement, Spread, MasterSpread, Polygon, GraphicLine, Rectangle, Oval, SplineItem, Group, State, Character, Sound, PlaceGun, Movie or Snippet).
parentPagePage readonlyThe page on which this page item appears.
preferencesPreferences readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightLineEndArrowHead:
ArrowHead.NONE
ArrowHead.SIMPLE_ARROW_HEAD
ArrowHead.SIMPLE_WIDE_ARROW_HEAD
ArrowHead.TRIANGLE_ARROW_HEAD
ArrowHead.TRIANGLE_WIDE_ARROW_HEAD
ArrowHead.BARBED_ARROW_HEAD
ArrowHead.CURVED_ARROW_HEAD
ArrowHead.CIRCLE_ARROW_HEAD
ArrowHead.CIRCLE_SOLID_ARROW_HEAD
ArrowHead.SQUARE_ARROW_HEAD
ArrowHead.SQUARE_SOLID_ARROW_HEAD
ArrowHead.BAR_ARROW_HEAD
r/wThe arrowhead applied to the end of the path.
rotationAnglenumber r/wThe rotatation angle of the PageItem. (Range: -360 to 360)
shearAnglenumber r/wThe skewing angle applied to the PageItem. (Range: -360 to 360)
strokeAlignmentStrokeAlignment:
StrokeAlignment.CENTER_ALIGNMENT
StrokeAlignment.INSIDE_ALIGNMENT
StrokeAlignment.OUTSIDE_ALIGNMENT
r/wThe stroke alignment applied to the PageItem.
strokeColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItem. Can also accept: String.
strokeCornerAdjustmentStrokeCornerAdjustment:
StrokeCornerAdjustment.NONE
StrokeCornerAdjustment.DASHES
StrokeCornerAdjustment.GAPS
StrokeCornerAdjustment.DASHES_AND_GAPS
r/wThe corner adjustment applied to the PageItem.
strokeDashAndGap Array of Measurement Unit (Number or String) r/wThe dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
strokeTintnumber r/wThe percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
strokeTransparencySettingsStrokeTransparencySetting readonlyTransparency settings for the stroke.
strokeTypeString
StrokeStyle
r/wThe name of the stroke style to apply. Can also accept: String.
strokeWeightMeasurement Unit (Number or String) r/wThe weight (in points) to apply to the PageItem's stroke.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
timingSettingsTimingSetting readonlyThe object timing settings.
topLeftCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
topLeftCornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
topRightCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe shape to apply to the top right corner of rectangular shapes
topRightCornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
transparencySettingsTransparencySetting readonlyTransparency settings.
verticalScalenumber r/wThe vertical scaling applied to the PageItem.
visiblebool r/wIf true, the PageItem is visible.
visibleBounds Array of Measurement Unit (Number or String) r/wThe bounds of the PageItem including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.

Class

PropertyTypeAccessDescription
AFTER_PLACEstring readonlyDispatched after a PageItem is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
BEFORE_PLACEstring readonlyDispatched before a PageItem is placed. This event bubbles. This event is cancelable. (default: beforePlace)

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)

void applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
Applies the specified object style.

ParameterTypeDescription
usingObjectStyleThe object style to apply.
clearingOverridesboolIf true, clears the PageItem's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyleboolIf true, clears attributes and formatting applied to the PageItem that are not defined in the object style. (Optional) (default: false)

BackgroundTask asynchronousExportFile (format: varies, to: File[, showingOptions: bool=false][, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
asynchronously exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
String
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
toFileThe path to the export file.
showingOptionsboolIf true, displays the export options dialog. (Optional) (default: false)
usingPDFExportPresetThe export style. (Optional)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

Array of PageItem changeObject ([reverseOrder: bool])
Finds objects that match the find what value and replace the objects with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

void clearObjectStyleOverrides ()
Clear overrides for object style

void clearTransformations ()
Clears transformations from the PageItem. Transformations include rotation, scaling, flipping, fitting, and shearing.

void convertShape (given: ConvertShapeOptions[, numberOfSides: number][, insetPercentage: number][, cornerRadius: Measurement Unit (Number or String)])
Converts the PageItem to a different shape.

ParameterTypeDescription
givenConvertShapeOptions:
ConvertShapeOptions.CONVERT_TO_RECTANGLE
ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_OVAL
ConvertShapeOptions.CONVERT_TO_TRIANGLE
ConvertShapeOptions.CONVERT_TO_POLYGON
ConvertShapeOptions.CONVERT_TO_LINE
ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE
ConvertShapeOptions.CONVERT_TO_OPEN_PATH
ConvertShapeOptions.CONVERT_TO_CLOSED_PATH
The PageItem's new shape.
numberOfSidesnumber (range: 3 - 100)The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentagenumber (range: 0 - 100)The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadiusMeasurement Unit (Number or String) (range: 0 - 800)The corner radius of the resulting rectangle. (Optional)

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

PageItem duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])
Duplicates the PageItem at the specified location or offset.

ParameterTypeDescription
to Array of 2 Units
Layer
Page
Spread
The location of the new PageItem, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by Array of Measurement Unit (Number or String)Amount by which to offset the new PageItem from the original PageItem's position. (Optional)

void exportFile (format: varies, to: File[, showingOptions: bool=false][, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
Exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
String
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
toFileThe path to the export file.
showingOptionsboolIf true, displays the export options dialog. (Optional) (default: false)
usingPDFExportPresetThe export style. (Optional)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

any extractLabel ([key: string])
Gets the label value associated with the specified key. If key string is null, then a list of key-value pairs associated with the item is returned.

ParameterTypeDescription
keystringThe key. (Optional)

Array of PageItem findObject ([reverseOrder: bool])
Finds objects that match the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

void fit (given: FitOptions)
Applies the specified fit option to content in a frame.

ParameterTypeDescription
givenFitOptions:
FitOptions.CONTENT_TO_FRAME
FitOptions.CENTER_CONTENT
FitOptions.PROPORTIONALLY
FitOptions.FRAME_TO_CONTENT
FitOptions.FILL_PROPORTIONALLY
FitOptions.APPLY_FRAME_FITTING_OPTIONS
The fit option to use.

void flipItem (given: Flip[, around: varies])
Flips the PageItem.

ParameterTypeDescription
givenFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
The axis around which to flip the PageItem.
aroundAnchorPoint
Array of 2 Units
The point around which to flip the PageItem. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Array of PageItem 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.

void markup (using: XMLElement)
Associates the page item with the specified XML element while preserving existing content.

ParameterTypeDescription
usingXMLElementThe XML element.

void move ([to: varies][, by: Array of Measurement Unit (Number or String)])
Moves the PageItem to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.

ParameterTypeDescription
to Array of 2 Units
Layer
Page
Spread
The new location of the PageItem,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by Array of Measurement Unit (Number or String)The amount (in measurement units) to move the PageItem relative to its current position, in the format (x, y). (Optional)

any override (destinationPage: Page)
Overrides a master page item and places the item on the document page as a new object.

ParameterTypeDescription
destinationPagePageThe document page that contains the master page item to override.

Array of any place (fileName: File[, showingOptions: bool=false][, withProperties: Object])
Places the file.

ParameterTypeDescription
fileNameFileThe file to place
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
withPropertiesObjectInitial values for properties of the placed object(s) (Optional)

void placeXML (using: XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.

ParameterTypeDescription
usingXMLElementThe XML element whose content you want to place.

void redefineScaling ([to: Array of number])
Apply an item's scaling to its content if possible.

ParameterTypeDescription
to Array of numberThe scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

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.
opposingCorners Array of any Opposing corners of new bounding box in the given coordinate space

void remove ()
Deletes the PageItem.

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
values Array 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.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
The selection status of the PageItem in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

Asset store (using: Library[, withProperties: Object])
Stores the object in the specified library.

ParameterTypeDescription
usingLibraryThe library in which to store the object.
withPropertiesObjectInitial values for properties of the new PageItem (Optional)

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

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.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.
withMatrix Array of 6 Reals
TransformationMatrix
Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent Array 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 string transformAgain ()
Transforms the PageItem using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformAgainIndividually ()
Transforms the PageItem using the last transformation performed on any PageItem. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgain ()
Transforms the PageItem using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgainIndividually ()
Transforms the PageItem using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

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

Element of

AnimationBehavior.animatedPageItem

ArticleChild.itemRef

ArticleMember.itemRef

AssignedStory.storyReference

Button.allPageItems

Button.overriddenMasterPageItem

Cell.allPageItems

Character.allPageItems

DataMergeImagePlaceholder.placeholderPageItem

Document.allPageItems

EPS.allPageItems

EPS.overriddenMasterPageItem

EPSText.allPageItems

EPSText.overriddenMasterPageItem

Footnote.allPageItems

FormField.allPageItems

FormField.overriddenMasterPageItem

Graphic.allPageItems

Graphic.overriddenMasterPageItem

GraphicLine.allPageItems

GraphicLine.overriddenMasterPageItem

Group.allPageItems

Group.overriddenMasterPageItem

Guide.overriddenMasterPageItem

HyperlinkPageItemSource.sourcePageItem

Image.allPageItems

Image.overriddenMasterPageItem

ImportedPage.allPageItems

ImportedPage.overriddenMasterPageItem

InsertionPoint.allPageItems

Layer.allPageItems

Line.allPageItems

MasterSpread.allPageItems

MediaItem.allPageItems

MediaItem.overriddenMasterPageItem

Movie.allPageItems

Movie.overriddenMasterPageItem

MultiStateObject.allPageItems

MultiStateObject.overriddenMasterPageItem

Oval.allPageItems

Oval.overriddenMasterPageItem

PDF.allPageItems

PDF.overriddenMasterPageItem

PICT.allPageItems

PICT.overriddenMasterPageItem

Page.allPageItems

PageItem.allPageItems

PageItem.overriddenMasterPageItem

Paragraph.allPageItems

Polygon.allPageItems

Polygon.overriddenMasterPageItem

Rectangle.allPageItems

Rectangle.overriddenMasterPageItem

Sound.allPageItems

Sound.overriddenMasterPageItem

SplineItem.allPageItems

SplineItem.overriddenMasterPageItem

Spread.allPageItems

Story.allPageItems

Table.allPageItems

Text.allPageItems

TextColumn.allPageItems

TextFrame.allPageItems

TextFrame.overriddenMasterPageItem

TextStyleRange.allPageItems

TimingTarget.dynamicTarget

WMF.allPageItems

WMF.overriddenMasterPageItem

Word.allPageItems

XMLElement.xmlContent

XmlStory.allPageItems

Used in:

ArticleMember ArticleMembers.add (itemRef: PageItem[, at: LocationOptions=LocationOptions.AT_END][, reference: ArticleMember][, withProperties: Object])

void Button.bringToFront ([reference: PageItem])

void Button.sendToBack ([reference: PageItem])

DataMergeImagePlaceholder DataMergeImagePlaceholders.add (placeholder: PageItem, field: DataMergeField[, withProperties: Object])

void Document.align (alignDistributeItems: Array of PageItem, alignOption: AlignOptions[, alignDistributeBounds: AlignDistributeBounds])

void Document.distribute (alignDistributeItems: Array of PageItem, distributeOption: DistributeOptions[, alignDistributeBounds: AlignDistributeBounds][, useDistributeMeasurement: bool][, absoluteDistributeMeasurement: Measurement Unit (Number or String)])

void EPSText.bringToFront ([reference: PageItem])

void EPSText.sendToBack ([reference: PageItem])

PageItem GraphicLine.addPath (with: Array of PageItem)

void GraphicLine.bringToFront ([reference: PageItem])

PageItem GraphicLine.excludeOverlapPath (with: Array of PageItem)

PageItem GraphicLine.intersectPath (with: Array of PageItem)

PageItem GraphicLine.makeCompoundPath (with: Array of PageItem)

PageItem GraphicLine.minusBack (with: Array of PageItem)

void GraphicLine.sendToBack ([reference: PageItem])

PageItem GraphicLine.subtractPath (with: Array of PageItem)

void Group.bringToFront ([reference: PageItem])

void Group.sendToBack ([reference: PageItem])

Group Groups.add (groupItems: Array of PageItem[, layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])

HyperlinkPageItemSource HyperlinkPageItemSources.add (source: PageItem[, withProperties: Object])

void Movie.bringToFront ([reference: PageItem])

void Movie.sendToBack ([reference: PageItem])

void MultiStateObject.addItemsAsState (pageitems: Array of PageItem)

void MultiStateObject.bringToFront ([reference: PageItem])

void MultiStateObject.sendToBack ([reference: PageItem])

PageItem Oval.addPath (with: Array of PageItem)

void Oval.bringToFront ([reference: PageItem])

PageItem Oval.excludeOverlapPath (with: Array of PageItem)

PageItem Oval.intersectPath (with: Array of PageItem)

PageItem Oval.makeCompoundPath (with: Array of PageItem)

PageItem Oval.minusBack (with: Array of PageItem)

void Oval.sendToBack ([reference: PageItem])

PageItem Oval.subtractPath (with: Array of PageItem)

PageItem PageItems.nextItem (obj: PageItem)

PageItem PageItems.previousItem (obj: PageItem)

PageItem Polygon.addPath (with: Array of PageItem)

void Polygon.bringToFront ([reference: PageItem])

PageItem Polygon.excludeOverlapPath (with: Array of PageItem)

PageItem Polygon.intersectPath (with: Array of PageItem)

PageItem Polygon.makeCompoundPath (with: Array of PageItem)

PageItem Polygon.minusBack (with: Array of PageItem)

void Polygon.sendToBack ([reference: PageItem])

PageItem Polygon.subtractPath (with: Array of PageItem)

PageItem Rectangle.addPath (with: Array of PageItem)

void Rectangle.bringToFront ([reference: PageItem])

PageItem Rectangle.excludeOverlapPath (with: Array of PageItem)

PageItem Rectangle.intersectPath (with: Array of PageItem)

PageItem Rectangle.makeCompoundPath (with: Array of PageItem)

PageItem Rectangle.minusBack (with: Array of PageItem)

void Rectangle.sendToBack ([reference: PageItem])

PageItem Rectangle.subtractPath (with: Array of PageItem)

void Sound.bringToFront ([reference: PageItem])

void Sound.sendToBack ([reference: PageItem])

PageItem SplineItem.addPath (with: Array of PageItem)

void SplineItem.bringToFront ([reference: PageItem])

PageItem SplineItem.excludeOverlapPath (with: Array of PageItem)

PageItem SplineItem.intersectPath (with: Array of PageItem)

PageItem SplineItem.makeCompoundPath (with: Array of PageItem)

PageItem SplineItem.minusBack (with: Array of PageItem)

void SplineItem.sendToBack ([reference: PageItem])

PageItem SplineItem.subtractPath (with: Array of PageItem)

void State.addItemsToState (pageitems: Array of PageItem)

PageItem TextFrame.addPath (with: Array of PageItem)

void TextFrame.bringToFront ([reference: PageItem])

PageItem TextFrame.excludeOverlapPath (with: Array of PageItem)

PageItem TextFrame.intersectPath (with: Array of PageItem)

PageItem TextFrame.makeCompoundPath (with: Array of PageItem)

PageItem TextFrame.minusBack (with: Array of PageItem)

void TextFrame.sendToBack ([reference: PageItem])

PageItem TextFrame.subtractPath (with: Array of PageItem)

PageItem XMLElement.placeIntoCopy (on: varies, placePoint: Array of Measurement Unit (Number or String), copyItem: PageItem[, retainExistingFrame: bool=false])

PageItem XMLElement.placeIntoInlineCopy (copyItem: PageItem[, retainExistingFrame: bool=false])

Return

Array of PageItem Application.changeObject ([reverseOrder: bool])

Array of PageItem Application.findObject ([reverseOrder: bool])

Array of PageItem Button.changeObject ([reverseOrder: bool])

PageItem Button.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem Button.findObject ([reverseOrder: bool])

Array of PageItem Cell.createOutlines ([deleteOriginal: bool=true])

Array of PageItem Character.createOutlines ([deleteOriginal: bool=true])

PageItem ClippingPathSettings.convertToFrame ()

Array of PageItem Column.createOutlines ([deleteOriginal: bool=true])

Array of PageItem Document.changeObject ([reverseOrder: bool])

Array of PageItem Document.findObject ([reverseOrder: bool])

Array of PageItem EPS.changeObject ([reverseOrder: bool])

PageItem EPS.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem EPS.findObject ([reverseOrder: bool])

Array of PageItem EPSText.changeObject ([reverseOrder: bool])

PageItem EPSText.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem EPSText.findObject ([reverseOrder: bool])

Array of PageItem FormField.changeObject ([reverseOrder: bool])

PageItem FormField.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem FormField.findObject ([reverseOrder: bool])

Array of PageItem Graphic.changeObject ([reverseOrder: bool])

PageItem Graphic.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem Graphic.findObject ([reverseOrder: bool])

PageItem GraphicLine.addPath (with: Array of PageItem)

Array of PageItem GraphicLine.changeObject ([reverseOrder: bool])

PageItem GraphicLine.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

PageItem GraphicLine.excludeOverlapPath (with: Array of PageItem)

Array of PageItem GraphicLine.findObject ([reverseOrder: bool])

PageItem GraphicLine.intersectPath (with: Array of PageItem)

PageItem GraphicLine.makeCompoundPath (with: Array of PageItem)

PageItem GraphicLine.minusBack (with: Array of PageItem)

Array of PageItem GraphicLine.releaseCompoundPath ()

PageItem GraphicLine.subtractPath (with: Array of PageItem)

Array of PageItem Group.changeObject ([reverseOrder: bool])

PageItem Group.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem Group.findObject ([reverseOrder: bool])

Array of PageItem Image.changeObject ([reverseOrder: bool])

PageItem Image.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem Image.findObject ([reverseOrder: bool])

Array of PageItem ImportedPage.changeObject ([reverseOrder: bool])

PageItem ImportedPage.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem ImportedPage.findObject ([reverseOrder: bool])

Array of PageItem InsertionPoint.createOutlines ([deleteOriginal: bool=true])

Array of PageItem Line.createOutlines ([deleteOriginal: bool=true])

Array of PageItem MediaItem.changeObject ([reverseOrder: bool])

PageItem MediaItem.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem MediaItem.findObject ([reverseOrder: bool])

Array of PageItem Movie.changeObject ([reverseOrder: bool])

Array of PageItem Movie.findObject ([reverseOrder: bool])

Array of PageItem MultiStateObject.changeObject ([reverseOrder: bool])

PageItem MultiStateObject.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem MultiStateObject.findObject ([reverseOrder: bool])

PageItem Oval.addPath (with: Array of PageItem)

Array of PageItem Oval.changeObject ([reverseOrder: bool])

PageItem Oval.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

PageItem Oval.excludeOverlapPath (with: Array of PageItem)

Array of PageItem Oval.findObject ([reverseOrder: bool])

PageItem Oval.intersectPath (with: Array of PageItem)

PageItem Oval.makeCompoundPath (with: Array of PageItem)

PageItem Oval.minusBack (with: Array of PageItem)

Array of PageItem Oval.releaseCompoundPath ()

PageItem Oval.subtractPath (with: Array of PageItem)

Array of PageItem PDF.changeObject ([reverseOrder: bool])

PageItem PDF.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem PDF.findObject ([reverseOrder: bool])

Array of PageItem PICT.changeObject ([reverseOrder: bool])

PageItem PICT.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem PICT.findObject ([reverseOrder: bool])

PageItem Page.placeXML (using: XMLElement, placePoint: Array of Measurement Unit (Number or String)[, autoflowing: bool=false])

PageItem Page.setContent (using: string[, relativeBasePath: string])

Array of PageItem PageItem.changeObject ([reverseOrder: bool])

PageItem PageItem.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem PageItem.findObject ([reverseOrder: bool])

Array of PageItem PageItem.getElements ()

PageItem PageItems.[] (index: number)

PageItem PageItems.anyItem ()

Array of PageItem PageItems.everyItem ()

PageItem PageItems.firstItem ()

PageItem PageItems.item (index: varies)

PageItem PageItems.itemByID (id: number)

PageItem PageItems.itemByName (name: string)

Array of PageItem PageItems.itemByRange (from: varies, to: varies)

PageItem PageItems.lastItem ()

PageItem PageItems.middleItem ()

PageItem PageItems.nextItem (obj: PageItem)

PageItem PageItems.previousItem (obj: PageItem)

Array of PageItem Paragraph.createOutlines ([deleteOriginal: bool=true])

PageItem Polygon.addPath (with: Array of PageItem)

Array of PageItem Polygon.changeObject ([reverseOrder: bool])

PageItem Polygon.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

PageItem Polygon.excludeOverlapPath (with: Array of PageItem)

Array of PageItem Polygon.findObject ([reverseOrder: bool])

PageItem Polygon.intersectPath (with: Array of PageItem)

PageItem Polygon.makeCompoundPath (with: Array of PageItem)

PageItem Polygon.minusBack (with: Array of PageItem)

Array of PageItem Polygon.releaseCompoundPath ()

PageItem Polygon.subtractPath (with: Array of PageItem)

PageItem Rectangle.addPath (with: Array of PageItem)

Array of PageItem Rectangle.changeObject ([reverseOrder: bool])

PageItem Rectangle.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

PageItem Rectangle.excludeOverlapPath (with: Array of PageItem)

Array of PageItem Rectangle.findObject ([reverseOrder: bool])

PageItem Rectangle.intersectPath (with: Array of PageItem)

PageItem Rectangle.makeCompoundPath (with: Array of PageItem)

PageItem Rectangle.minusBack (with: Array of PageItem)

Array of PageItem Rectangle.releaseCompoundPath ()

PageItem Rectangle.subtractPath (with: Array of PageItem)

Array of PageItem Row.createOutlines ([deleteOriginal: bool=true])

Array of PageItem Sound.changeObject ([reverseOrder: bool])

Array of PageItem Sound.findObject ([reverseOrder: bool])

PageItem SplineItem.addPath (with: Array of PageItem)

Array of PageItem SplineItem.changeObject ([reverseOrder: bool])

PageItem SplineItem.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

PageItem SplineItem.excludeOverlapPath (with: Array of PageItem)

Array of PageItem SplineItem.findObject ([reverseOrder: bool])

PageItem SplineItem.intersectPath (with: Array of PageItem)

PageItem SplineItem.makeCompoundPath (with: Array of PageItem)

PageItem SplineItem.minusBack (with: Array of PageItem)

Array of PageItem SplineItem.releaseCompoundPath ()

PageItem SplineItem.subtractPath (with: Array of PageItem)

PageItem Spread.placeXML (using: XMLElement, placePoint: Array of Measurement Unit (Number or String)[, autoflowing: bool=false])

PageItem Spread.setContent (using: string[, relativeBasePath: string])

Array of PageItem Story.createOutlines ([deleteOriginal: bool=true])

Array of PageItem Table.createOutlines ([deleteOriginal: bool=true])

Array of PageItem Text.createOutlines ([deleteOriginal: bool=true])

Array of PageItem TextColumn.createOutlines ([deleteOriginal: bool=true])

PageItem TextFrame.addPath (with: Array of PageItem)

Array of PageItem TextFrame.changeObject ([reverseOrder: bool])

Array of PageItem TextFrame.createOutlines ([deleteOriginal: bool=true])

PageItem TextFrame.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

PageItem TextFrame.excludeOverlapPath (with: Array of PageItem)

Array of PageItem TextFrame.findObject ([reverseOrder: bool])

PageItem TextFrame.intersectPath (with: Array of PageItem)

PageItem TextFrame.makeCompoundPath (with: Array of PageItem)

PageItem TextFrame.minusBack (with: Array of PageItem)

Array of PageItem TextFrame.releaseCompoundPath ()

PageItem TextFrame.subtractPath (with: Array of PageItem)

Array of PageItem TextStyleRange.createOutlines ([deleteOriginal: bool=true])

Array of PageItem WMF.changeObject ([reverseOrder: bool])

PageItem WMF.duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])

Array of PageItem WMF.findObject ([reverseOrder: bool])

Array of PageItem Word.createOutlines ([deleteOriginal: bool=true])

PageItem XMLElement.placeIntoCopy (on: varies, placePoint: Array of Measurement Unit (Number or String), copyItem: PageItem[, retainExistingFrame: bool=false])

PageItem XMLElement.placeIntoFrame (on: varies, geometricBounds: Array of Measurement Unit (Number or String))

PageItem XMLElement.placeIntoInlineCopy (copyItem: PageItem[, retainExistingFrame: bool=false])

PageItem XMLElement.placeIntoInlineFrame (dimensions: Array of Measurement Unit (Number or String))

PageItem XMLElement.setContent (using: string[, relativeBasePath: string])

Array of PageItem XmlStory.createOutlines ([deleteOriginal: bool=true])

Jongware, 17-May-2011 v3.0.3fContents :: Index