PageItem
An item on a page, including rectangles, ellipses, graphic lines, polygons, groups, text frames, and buttons.
Superclass of FormField, GraphicLine, Group, Oval, Polygon, Rectangle, 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. |
| anchoredObjectSettings | AnchoredObjectSetting | readonly | Anchored object settings. |
| appliedObjectStyle | ObjectStyle | r/w | The object style applied to the PageItem. |
| associatedXMLElement | XMLItem | readonly | The XML element associated with the PageItem. |
| contentTransparencySettings | ContentTransparencySetting | readonly | Transparency settings for the content of the PageItem. |
| cornerOption | 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 corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight. |
| cornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect. |
| 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. |
| epss | EPSs | readonly | A collection of EPS files. |
| 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. |
| frameFittingOptions | FrameFittingOption | readonly | The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application. |
| 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]. |
| graphicLines | GraphicLines | readonly | A collection of graphic lines. |
| graphics | Graphics | readonly | A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). |
| groups | Groups | readonly | A collection of groups. |
| horizontalScale | number | r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| id | number | readonly | The unique ID of the PageItem. |
| images | Images | readonly | A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). |
| indesignPageItems | IndesignPageItems | readonly | A collection of imported InDesign pages. |
| index | number | readonly | The index of the PageItem within its containing object. |
| 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. |
| localDisplaySetting | DisplaySettingOptions: DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.TYPICAL DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.DEFAULT_VALUE |
r/w | Display performance options for the PageItem. |
| lockState | LockStateValues: LockStateValues.NONE LockStateValues.UNMANAGED_STORY LockStateValues.CHECKED_IN_STORY LockStateValues.CHECKED_OUT_STORY LockStateValues.LOCKED_STORY LockStateValues.EMBEDDED_STORY LockStateValues.MISSING_LOCK_STATE LockStateValues.MIXED_LOCK_STATE |
readonly | The lock state. |
| locked | bool | r/w | If true, the PageItem is locked. |
| miterLimit | number | r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500) |
| movies | Movies | readonly | A collection of movies. |
| nonprinting | bool | r/w | If true, the PageItem does not print. |
| ovals | Ovals | readonly | A collection of ellipses. |
| 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. |
| pageItems | PageItems | readonly | The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. |
| parent | Button Cell Character Document Footnote GraphicLine Group InsertionPoint Layer Line MasterSpread Oval Page PageItem Paragraph Polygon Rectangle Spread State Story Table Text TextColumn TextFrame TextStyleRange Word XMLElement XmlStory |
readonly | The parent of the PageItem (a XMLElement, XmlStory, Spread, MasterSpread, PageItem, Oval, Rectangle, Polygon, GraphicLine, Group, State, TextFrame, Story, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table, Document, Layer, Button, InsertionPoint, Page or Footnote). |
| paths | Paths | readonly | A collection of paths. |
| pdfs | PDFs | readonly | A collection of PDF files. |
| picts | PICTs | readonly | A collection of PICT graphics. |
| polygons | Polygons | readonly | A collection of polygons. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rectangles | Rectangles | readonly | A collection of rectangles. |
| 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) |
| sounds | Sounds | readonly | A collection of sound clips. |
| 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. |
| textFrames | TextFrames | readonly | A collection of text frames. |
| textPaths | TextPaths | readonly | A collection of text paths. |
| textWrapPreferences | TextWrapPreference | readonly | The text wrap preference properties that define the default formatting for wrapping text around objects. |
| transparencySettings | TransparencySetting | readonly | Transparency settings. |
| verticalScale | number | r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| 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. |
| wmfs | WMFs | readonly | A collection of WMF graphics. |
Methods
Instances
PageItem addPath (with:
Array
of PageItem)
Creates a new page item by combining the PageItem with other objects. Deletes the objects if they do not intersect.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The object(s) to add. |
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.
void bringForward ()
Brings the PageItem forward one level in its layer.
void bringToFront ()
Brings the PageItem to the front.
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) |
bool checkIn ([versionComments:
string][, forceSave:
bool=false])
Checks in the story or stories.
| Parameter | Type | Description |
|---|---|---|
| versionComments | string | The comment for this version. (Optional) |
| forceSave | bool | If true, forcibly saves a version. (Optional) (default: false) |
bool checkOut ()
Checks out the story.
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:
any][, 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) |
PageItem excludeOverlapPath (with:
Array
of PageItem)
Creates a new page item by excluding the overlapping areas of the PageItem and other objects.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The object(s) to exclude. |
void exportFile (format:
any, to:
File[, showingOptions:
bool=false][, 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. |
| showingOptions | bool | If true, displays the export options dialog. (Optional) (default: false) |
| 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 | The fit option to use. |
void flipItem (given:
Flip[, around:
any])
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. |
PageItem intersectPath (with:
Array
of PageItem)
Creates a new page item by intersecting the PageItem with other objects. Returns an error if the objects do not intersect.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The object(s) with which to intersect. |
PageItem makeCompoundPath (with:
Array
of PageItem)
Creates a compound path by combining the path(s) of the PageItem with the paths of other objects.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The other objects whose paths to include in the new compound path. |
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. |
PageItem minusBack (with:
Array
of PageItem)
Creates a new page item by reverse subtracting the overlapping areas of the PageItem and other objects.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The object(s) to reverse subtract. |
void move ([to:
any][, 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[, showingOptions:
bool=false][, withProperties:
Object])
Places the file.
| Parameter | Type | Description |
|---|---|---|
| fileName | File | The file to place |
| showingOptions | bool | Whether to display the import options dialog (Optional) (default: false) |
| 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) |
Array
of PageItem releaseCompoundPath ()
Releases a compound path.
void remove ()
Deletes the PageItem.
void removeOverride ()
Removes the override from a previously overridden master page item.
any resolve (location:
any, 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 | 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) |
bool revert ()
Reverts the document to its state at the last save operation.
void select ([existingSelection:
SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.
| Parameter | Type | Description |
|---|---|---|
| existingSelection | SelectionOptions: 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) |
void sendBackward ()
Sends the PageItem back one level in its layer.
void sendToBack ()
Sends the PageItem to the back.
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) |
PageItem subtractPath (with:
Array
of PageItem)
Creates a new page item by subtracting the overlapping areas of the PageItem and other objects.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The object(s) to subtract. |
string toSource ()
Generates a string which, if executed, will return the PageItem.
string toSpecifier ()
Retrieves the object specifier.
void transform (in:
CoordinateSpaces, from:
any, withMatrix:
any[, replacingCurrent:
any][, consideringRulerUnits:
bool=false])
Transform the page item.
| Parameter | Type | Description |
|---|---|---|
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_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 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.
| Parameter | Type | Description |
|---|---|---|
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES | The coordinate space to use |
Element of
AssignedStory.storyReference
Button.allPageItems
Button.overriddenMasterPageItem
Cell.allPageItems
Character.allPageItems
DataMergeImagePlaceholder.placeholderPageItem
Document.allPageItems
EPS.overriddenMasterPageItem
Footnote.allPageItems
FormField.allPageItems
FormField.overriddenMasterPageItem
Graphic.overriddenMasterPageItem
GraphicLine.allPageItems
GraphicLine.overriddenMasterPageItem
Group.allPageItems
Group.overriddenMasterPageItem
Guide.overriddenMasterPageItem
HyperlinkPageItemSource.sourcePageItem
Image.overriddenMasterPageItem
ImportedPage.overriddenMasterPageItem
InsertionPoint.allPageItems
Layer.allPageItems
Line.allPageItems
MasterSpread.allPageItems
Movie.overriddenMasterPageItem
Oval.allPageItems
Oval.overriddenMasterPageItem
PDF.overriddenMasterPageItem
PICT.overriddenMasterPageItem
Page.allPageItems
PageItem.allPageItems
PageItem.overriddenMasterPageItem
Paragraph.allPageItems
Polygon.allPageItems
Polygon.overriddenMasterPageItem
Rectangle.allPageItems
Rectangle.overriddenMasterPageItem
RingStyle.ringStyleGraphicUid
Sound.overriddenMasterPageItem
Spread.allPageItems
Story.allPageItems
Table.allPageItems
Text.allPageItems
TextColumn.allPageItems
TextFrame.allPageItems
TextFrame.overriddenMasterPageItem
TextStyleRange.allPageItems
WMF.overriddenMasterPageItem
Word.allPageItems
XMLElement.xmlContent
XmlStory.allPageItems
Used in:
PageItem Button.addPath (with: Array of PageItem)
PageItem Button.excludeOverlapPath (with: Array of PageItem)
PageItem Button.intersectPath (with: Array of PageItem)
PageItem Button.makeCompoundPath (with: Array of PageItem)
PageItem Button.minusBack (with: Array of PageItem)
PageItem Button.subtractPath (with: Array of PageItem)
Button Buttons.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Text Character.duplicate (to: LocationOptions[, reference: any])
Text Character.move (to: LocationOptions[, reference: any])
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)])
PageItem FormField.addPath (with: Array of PageItem)
PageItem FormField.excludeOverlapPath (with: Array of PageItem)
PageItem FormField.intersectPath (with: Array of PageItem)
PageItem FormField.makeCompoundPath (with: Array of PageItem)
PageItem FormField.minusBack (with: Array of PageItem)
PageItem FormField.subtractPath (with: Array of PageItem)
PageItem GraphicLine.addPath (with: Array of 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)
PageItem GraphicLine.subtractPath (with: Array of PageItem)
GraphicLine GraphicLines.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
PageItem Group.addPath (with: Array of PageItem)
PageItem Group.excludeOverlapPath (with: Array of PageItem)
PageItem Group.intersectPath (with: Array of PageItem)
PageItem Group.makeCompoundPath (with: Array of PageItem)
PageItem Group.minusBack (with: Array of PageItem)
PageItem Group.subtractPath (with: Array of PageItem)
Group Groups.add (groupItems: Array of PageItem[, layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
HyperlinkPageItemSource HyperlinkPageItemSources.add (source: PageItem[, withProperties: Object])
Text InsertionPoint.duplicate (to: LocationOptions[, reference: any])
Text InsertionPoint.move (to: LocationOptions[, reference: any])
Text Line.duplicate (to: LocationOptions[, reference: any])
Text Line.move (to: LocationOptions[, reference: any])
Movie Movies.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
PageItem Oval.addPath (with: Array of 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)
PageItem Oval.subtractPath (with: Array of PageItem)
Oval Ovals.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
PageItem PageItem.addPath (with: Array of PageItem)
PageItem PageItem.excludeOverlapPath (with: Array of PageItem)
PageItem PageItem.intersectPath (with: Array of PageItem)
PageItem PageItem.makeCompoundPath (with: Array of PageItem)
PageItem PageItem.minusBack (with: Array of PageItem)
PageItem PageItem.subtractPath (with: Array of PageItem)
array of PageItem PageItems.itemByRange (from: any, to: any)
PageItem PageItems.nextItem (obj: PageItem)
PageItem PageItems.previousItem (obj: PageItem)
Text Paragraph.duplicate (to: LocationOptions[, reference: any])
Text Paragraph.move (to: LocationOptions[, reference: any])
PageItem Polygon.addPath (with: Array of 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)
PageItem Polygon.subtractPath (with: Array of PageItem)
Polygon Polygons.add ([layer: Layer][, numberOfSides: number][, insetPercentage: number][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
PageItem Rectangle.addPath (with: Array of 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)
PageItem Rectangle.subtractPath (with: Array of PageItem)
Rectangle Rectangles.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Sound Sounds.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Text Story.duplicate (to: LocationOptions[, reference: any])
Text Story.move (to: LocationOptions[, reference: any])
Text Text.duplicate (to: LocationOptions[, reference: any])
Text Text.move (to: LocationOptions[, reference: any])
Text TextColumn.duplicate (to: LocationOptions[, reference: any])
Text TextColumn.move (to: LocationOptions[, reference: any])
PageItem TextFrame.addPath (with: Array of 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)
PageItem TextFrame.subtractPath (with: Array of PageItem)
TextFrame TextFrames.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Text TextStyleRange.duplicate (to: LocationOptions[, reference: any])
Text TextStyleRange.move (to: LocationOptions[, reference: any])
Text Word.duplicate (to: LocationOptions[, reference: any])
Text Word.move (to: LocationOptions[, reference: any])
void XMLElement.markup (using: any)
PageItem XMLElement.placeIntoCopy (on: any, placePoint: Array of Measurement Unit (Number or String), copyItem: PageItem[, retainExistingFrame: bool=false])
PageItem XMLElement.placeIntoInlineCopy (copyItem: PageItem[, retainExistingFrame: bool=false])
void XMLElement.placeXML (using: any)
XMLElement XMLElements.add (markupTag: any[, xmlContent: any][, withProperties: Object])
Text XmlStory.duplicate (to: LocationOptions[, reference: any])
Return
Array of PageItem Application.changeObject ([reverseOrder: bool])
Array of PageItem Application.findObject ([reverseOrder: bool])
PageItem Button.addPath (with: Array of PageItem)
Array of PageItem Button.changeObject ([reverseOrder: bool])
PageItem Button.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem Button.excludeOverlapPath (with: Array of PageItem)
Array of PageItem Button.findObject ([reverseOrder: bool])
PageItem Button.intersectPath (with: Array of PageItem)
PageItem Button.makeCompoundPath (with: Array of PageItem)
PageItem Button.minusBack (with: Array of PageItem)
Array of PageItem Button.releaseCompoundPath ()
PageItem Button.subtractPath (with: Array of PageItem)
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: any][, by: Array of Measurement Unit (Number or String)])
Array of PageItem EPS.findObject ([reverseOrder: bool])
PageItem FormField.addPath (with: Array of PageItem)
Array of PageItem FormField.changeObject ([reverseOrder: bool])
PageItem FormField.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem FormField.excludeOverlapPath (with: Array of PageItem)
Array of PageItem FormField.findObject ([reverseOrder: bool])
PageItem FormField.intersectPath (with: Array of PageItem)
PageItem FormField.makeCompoundPath (with: Array of PageItem)
PageItem FormField.minusBack (with: Array of PageItem)
Array of PageItem FormField.releaseCompoundPath ()
PageItem FormField.subtractPath (with: Array of PageItem)
Array of PageItem Graphic.changeObject ([reverseOrder: bool])
PageItem Graphic.duplicate ([to: any][, 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: any][, 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)
PageItem Group.addPath (with: Array of PageItem)
Array of PageItem Group.changeObject ([reverseOrder: bool])
PageItem Group.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem Group.excludeOverlapPath (with: Array of PageItem)
Array of PageItem Group.findObject ([reverseOrder: bool])
PageItem Group.intersectPath (with: Array of PageItem)
PageItem Group.makeCompoundPath (with: Array of PageItem)
PageItem Group.minusBack (with: Array of PageItem)
Array of PageItem Group.releaseCompoundPath ()
PageItem Group.subtractPath (with: Array of PageItem)
Array of PageItem Image.changeObject ([reverseOrder: bool])
PageItem Image.duplicate ([to: any][, 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: any][, 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])
PageItem Oval.addPath (with: Array of PageItem)
Array of PageItem Oval.changeObject ([reverseOrder: bool])
PageItem Oval.duplicate ([to: any][, 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: any][, 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: any][, 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])
PageItem PageItem.addPath (with: Array of PageItem)
Array of PageItem PageItem.changeObject ([reverseOrder: bool])
PageItem PageItem.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem PageItem.excludeOverlapPath (with: Array of PageItem)
Array of PageItem PageItem.findObject ([reverseOrder: bool])
Array of PageItem PageItem.getElements ()
PageItem PageItem.intersectPath (with: Array of PageItem)
PageItem PageItem.makeCompoundPath (with: Array of PageItem)
PageItem PageItem.minusBack (with: Array of PageItem)
Array of PageItem PageItem.releaseCompoundPath ()
PageItem PageItem.subtractPath (with: Array of PageItem)
PageItem PageItems.anyItem ()
Array of PageItem PageItems.everyItem ()
PageItem PageItems.firstItem ()
PageItem PageItems.item (index: any)
PageItem PageItems.itemByID (id: number)
PageItem PageItems.itemByName (name: string)
Array of PageItem PageItems.itemByRange (from: any, to: any)
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: any][, 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: any][, 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])
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: any][, 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: any][, 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: any, placePoint: Array of Measurement Unit (Number or String), copyItem: PageItem[, retainExistingFrame: bool=false])
PageItem XMLElement.placeIntoFrame (on: any, 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, 27-Jun-2010 v3.0.3d | Contents :: Index |