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
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| absoluteFlip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | Indicates whether the PageItem has been flipped independently of its parent object and, if yes, the direction in which the PageItem was flipped. |
| absoluteHorizontalScale | number | r/w | The horizontal scale of the PageItem relative to its containing object. |
| absoluteRotationAngle | number | r/w | The rotation angle of the PageItem relative to its containing object. (Range: -360 to 360) |
| absoluteShearAngle | number | r/w | The skewing angle of the PageItem relative to its containing object. (Range: -360 to 360) |
| absoluteVerticalScale | number | r/w | The vertical scale of the PageItem relative to its containing object. |
| allGraphics | Array of Graphic | readonly | Lists all graphics contained by the PageItem. |
| allPageItems | Array of PageItem | readonly | Lists all page items contained by the PageItem. |
| allowOverrides | bool | r/w | If true, the master page item can be overridden. |
| animationSettings | AnimationSetting | readonly | The page item animation settings. |
| appliedObjectStyle | ObjectStyle | r/w | The object style applied to the PageItem. |
| associatedXMLElement | XMLItem | readonly | The XML element associated with the PageItem. |
| bottomLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the bottom left corner of rectangular shapes. |
| bottomLeftCornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes |
| bottomRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the bottom right corner of rectangular shapes. |
| bottomRightCornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
| contentTransparencySettings | ContentTransparencySetting | readonly | Transparency settings for the content of the PageItem. |
| endCap | EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP |
r/w | The end shape of an open path. |
| endJoin | EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN |
r/w | The corner join applied to the PageItem. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItem. . Can also accept: String. |
| fillTint | number | r/w | The 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.) |
| fillTransparencySettings | FillTransparencySetting | readonly | Transparency settings for the fill applied to the PageItem. |
| flip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | The direction in which to flip the printed image. |
| gapColor | Swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. |
| gapTint | number | r/w | The 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/w | The 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. |
| gradientFillAngle | number | r/w | The angle of a linear gradient applied to the fill of the PageItem. (Range: -180 to 180) |
| gradientFillLength | Measurement Unit (Number or String) | r/w | The 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/w | The starting point (in page coordinates) of a gradient applied to the fill of the PageItem, in the format [x, y]. |
| gradientStrokeAngle | number | r/w | The angle of a linear gradient applied to the stroke of the PageItem. (Range: -180 to 180) |
| gradientStrokeLength | Measurement Unit (Number or String) | r/w | The 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/w | The starting point (in page coordinates) of a gradient applied to the stroke of the PageItem, in the format [x, y]. |
| horizontalScale | number | r/w | The horizontal scaling applied to the PageItem. |
| id | number | readonly | The unique ID of the PageItem. |
| index | number | readonly | The index of the PageItem within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| itemLayer | Layer | r/w | The layer that the PageItem is on. |
| label | string | r/w | A property that can be set to any string. |
| leftLineEnd | ArrowHead: 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/w | The arrowhead applied to the start of the path. |
| locked | bool | r/w | If true, the PageItem is locked. |
| miterLimit | number (range: 1 - 500) | r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4) |
| name | string | r/w | The name of the PageItem. |
| nonprinting | bool | r/w | If true, the PageItem does not print. |
| overprintFill | bool | r/w | If true, the PageItem's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
| overprintGap | bool | r/w | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
| overprintStroke | bool | r/w | If true, the PageItem's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
| overridden | bool | readonly | If 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. |
| overriddenMasterPageItem | Graphic Guide Movie PageItem Sound |
readonly | An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound. |
| parent | Character GraphicLine Group MasterSpread Movie Oval PlaceGun Polygon Rectangle Snippet Sound SplineItem Spread State XMLElement |
readonly | The parent of the PageItem (a XMLElement, Spread, MasterSpread, Polygon, GraphicLine, Rectangle, Oval, SplineItem, Group, State, Character, Sound, PlaceGun, Movie or Snippet). |
| parentPage | Page | readonly | The page on which this page item appears. |
| preferences | Preferences | readonly | A collection of preferences objects. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rightLineEnd | ArrowHead: 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/w | The arrowhead applied to the end of the path. |
| rotationAngle | number | r/w | The rotatation angle of the PageItem. (Range: -360 to 360) |
| shearAngle | number | r/w | The skewing angle applied to the PageItem. (Range: -360 to 360) |
| strokeAlignment | StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT |
r/w | The stroke alignment applied to the PageItem. |
| strokeColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItem. Can also accept: String. |
| strokeCornerAdjustment | StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS |
r/w | The corner adjustment applied to the PageItem. |
| strokeDashAndGap | Array of Measurement Unit (Number or String) | r/w | The 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]. |
| strokeTint | number | r/w | The 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.) |
| strokeTransparencySettings | StrokeTransparencySetting | readonly | Transparency settings for the stroke. |
| strokeType | String StrokeStyle |
r/w | The name of the stroke style to apply. Can also accept: String. |
| strokeWeight | Measurement Unit (Number or String) | r/w | The weight (in points) to apply to the PageItem's stroke. |
| textWrapPreferences | TextWrapPreference | readonly | The text wrap preference properties that define the default formatting for wrapping text around objects. |
| timingSettings | TimingSetting | readonly | The object timing settings. |
| topLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The 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. |
| topLeftCornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes |
| topRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the top right corner of rectangular shapes |
| topRightCornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
| transparencySettings | TransparencySetting | readonly | Transparency settings. |
| verticalScale | number | r/w | The vertical scaling applied to the PageItem. |
| visible | bool | r/w | If true, the PageItem is visible. |
| visibleBounds | Array of Measurement Unit (Number or String) | r/w | The 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
| Property | Type | Access | Description |
|---|---|---|---|
| AFTER_PLACE | string | readonly | Dispatched after a PageItem is placed. This event bubbles. This event is not cancelable. (default: afterPlace) |
| BEFORE_PLACE | string | readonly | Dispatched 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void applyObjectStyle (using:
ObjectStyle[, clearingOverrides:
bool=true][, clearingOverridesThroughRootObjectStyle:
bool=false])
Applies the specified object style.
| Parameter | Type | Description |
|---|---|---|
| using | ObjectStyle | The object style to apply. |
| clearingOverrides | bool | If true, clears the PageItem's existing attributes before applying the style. (Optional) (default: true) |
| clearingOverridesThroughRootObjectStyle | bool | If true, clears attributes and formatting applied to the PageItem that are not defined in the object style. (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.
| Parameter | Type | Description |
|---|---|---|
| reverseOrder | bool | If 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.
| Parameter | Type | Description |
|---|---|---|
| given | ConvertShapeOptions: 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. |
| numberOfSides | number (range: 3 - 100) | The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) |
| insetPercentage | number (range: 0 - 100) | The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) |
| cornerRadius | Measurement 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.
| Parameter | Type | Description |
|---|---|---|
| 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[, using:
PDFExportPreset][, versionComments:
string][, forceSave:
bool=false])
Exports the object(s) to a file.
| Parameter | Type | Description |
|---|---|---|
| format | ExportFormat 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. |
| to | File | The path to the export file. |
| using | PDFExportPreset | The export style. (Optional) |
| versionComments | string | The comment for this version. (Optional) |
| forceSave | bool | If true, forcibly saves a version. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array
of PageItem findObject ([reverseOrder:
bool])
Finds objects that match the find what value.
| Parameter | Type | Description |
|---|---|---|
| reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.
| Parameter | Type | Description |
|---|---|---|
| given | FitOptions: 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.
| Parameter | Type | Description |
|---|---|---|
| given | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH | The axis around which to flip the PageItem. |
| around | AnchorPoint 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.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void markup (using:
XMLElement)
Associates the page item with the specified XML element while preserving existing content.
| Parameter | Type | Description |
|---|---|---|
| using | XMLElement | The 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.
| Parameter | Type | Description |
|---|---|---|
| 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.
| Parameter | Type | Description |
|---|---|---|
| destinationPage | Page | The document page that contains the master page item to override. |
Array
of any place (fileName:
File[, withProperties:
Object])
Places a file
| Parameter | Type | Description |
|---|---|---|
| fileName | File | The file to place |
| withProperties | Object | Initial 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.
| Parameter | Type | Description |
|---|---|---|
| using | XMLElement | The XML element whose content you want to place. |
void redefineScaling ([to:
Array
of number])
Apply an item's scaling to its content if possible.
| Parameter | Type | Description |
|---|---|---|
| to | Array of number | The 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
| Parameter | Type | Description |
|---|---|---|
| in | boundsKind: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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
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.
| Parameter | Type | Description |
|---|---|---|
| in | BoundingBoxLimits 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. |
| from | AnchorPoint 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. |
| by | ResizeMethods: 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. |
| resizeIndividually | bool | 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 | bool | If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
any resolve (location:
varies, in:
CoordinateSpaces[, consideringRulerUnits:
bool=false])
Get the coordinates of the given location in the specified coordinate system.
| Parameter | Type | Description |
|---|---|---|
| location | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use. |
| consideringRulerUnits | bool | If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
Asset store (using:
Library[, withProperties:
Object])
Stores the object in the specified library.
| Parameter | Type | Description |
|---|---|---|
| using | Library | The library in which to store the object. |
| withProperties | Object | Initial 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.
| Parameter | Type | Description |
|---|---|---|
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use |
| from | AnchorPoint 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) |
| consideringRulerUnits | bool | 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) |
Array
of TransformationMatrix transformValuesOf (in:
CoordinateSpaces)
Get the transformation values of the page item.
| Parameter | Type | Description |
|---|---|---|
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use |
Element of
AnimationBehavior.animatedPageItem
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:
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, 23-Mar-2011 v3.0.3d | Contents :: Index |