PageItem

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

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

Instances

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

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

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.

void clearObjectStyleOverrides ()
Clear overrides for object style

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

Array of any contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])
Duplicate an object and place it into the target page item.

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

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.

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

string extractLabel (key: string)
Gets the label value associated with the specified key.

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

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

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

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.

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

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.

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

Array of any place (fileName: File[, withProperties: Object])
Places a file

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

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

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

void remove ()
Deletes the PageItem.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

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.

any resolve (location: varies, in: CoordinateSpaces[, consideringRulerUnits: bool=false])
Get the coordinates of the given location in the specified coordinate system.

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

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.

Array of TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

AnimationBehavior.animatedPageItem

ArticleChild.itemRef

ArticleMember.itemRef

AssignedStory.storyReference

Button.allPageItems

Button.overriddenMasterPageItem

Cell.allPageItems

Character.allPageItems

CheckBox.allPageItems

CheckBox.overriddenMasterPageItem

ComboBox.allPageItems

ComboBox.overriddenMasterPageItem

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

HtmlItem.allPageItems

HtmlItem.overriddenMasterPageItem

HyperlinkPageItemSource.sourcePageItem

Image.allPageItems

Image.overriddenMasterPageItem

ImportedPage.allPageItems

ImportedPage.overriddenMasterPageItem

InsertionPoint.allPageItems

Layer.allPageItems

Line.allPageItems

ListBox.allPageItems

ListBox.overriddenMasterPageItem

MasterSpread.allPageItems

MasterSpread.primaryTextFrame

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

RadioButton.allPageItems

RadioButton.overriddenMasterPageItem

Rectangle.allPageItems

Rectangle.overriddenMasterPageItem

SignatureField.allPageItems

SignatureField.overriddenMasterPageItem

Sound.allPageItems

Sound.overriddenMasterPageItem

SplineItem.allPageItems

SplineItem.overriddenMasterPageItem

Spread.allPageItems

Story.allPageItems

Table.allPageItems

Text.allPageItems

TextBox.allPageItems

TextBox.overriddenMasterPageItem

TextColumn.allPageItems

TextFrame.allPageItems

TextFrame.overriddenMasterPageItem

TextStyleRange.allPageItems

TimingTarget.dynamicTarget

WMF.allPageItems

WMF.overriddenMasterPageItem

Word.allPageItems

XMLElement.xmlContent

XmlStory.allPageItems

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

void Button.bringToFront ([reference: PageItem])

array of varies=any Button.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void Button.sendToBack ([reference: PageItem])

void CheckBox.bringToFront ([reference: PageItem])

array of varies=any CheckBox.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void CheckBox.sendToBack ([reference: PageItem])

void ComboBox.bringToFront ([reference: PageItem])

array of varies=any ComboBox.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void ComboBox.sendToBack ([reference: PageItem])

void ContentPlacerObject.load (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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

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

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

array of varies=any EPS.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void EPSText.bringToFront ([reference: PageItem])

array of varies=any EPSText.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void EPSText.sendToBack ([reference: PageItem])

array of varies=any FormField.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

array of varies=any Graphic.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

PageItem GraphicLine.addPath (with: Array of PageItem)

void GraphicLine.bringToFront ([reference: PageItem])

array of varies=any GraphicLine.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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])

array of varies=any Group.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void Group.sendToBack ([reference: PageItem])

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

array of varies=any HtmlItem.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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

array of varies=any Image.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

array of varies=any ImportedPage.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void ListBox.bringToFront ([reference: PageItem])

array of varies=any ListBox.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void ListBox.sendToBack ([reference: PageItem])

array of varies=any MasterSpread.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false])

array of varies=any MediaItem.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void Movie.bringToFront ([reference: PageItem])

array of varies=any Movie.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void Movie.sendToBack ([reference: PageItem])

void MultiStateObject.addItemsAsState (pageitems: Array of PageItem)

void MultiStateObject.bringToFront ([reference: PageItem])

array of varies=any MultiStateObject.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void MultiStateObject.sendToBack ([reference: PageItem])

PageItem Oval.addPath (with: Array of PageItem)

void Oval.bringToFront ([reference: PageItem])

array of varies=any Oval.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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)

array of varies=any PDF.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

array of varies=any PICT.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

array of varies=any Page.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false])

array of varies=any PageItem.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

PageItem PageItems.nextItem (obj: PageItem)

PageItem PageItems.previousItem (obj: PageItem)

PageItem Polygon.addPath (with: Array of PageItem)

void Polygon.bringToFront ([reference: PageItem])

array of varies=any Polygon.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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)

void RadioButton.bringToFront ([reference: PageItem])

array of varies=any RadioButton.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void RadioButton.sendToBack ([reference: PageItem])

PageItem Rectangle.addPath (with: Array of PageItem)

void Rectangle.bringToFront ([reference: PageItem])

array of varies=any Rectangle.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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 SignatureField.bringToFront ([reference: PageItem])

array of varies=any SignatureField.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void SignatureField.sendToBack ([reference: PageItem])

void Sound.bringToFront ([reference: PageItem])

array of varies=any Sound.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void Sound.sendToBack ([reference: PageItem])

PageItem SplineItem.addPath (with: Array of PageItem)

void SplineItem.bringToFront ([reference: PageItem])

array of varies=any SplineItem.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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)

array of varies=any Spread.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false])

void State.addItemsToState (pageitems: Array of PageItem)

void TextBox.bringToFront ([reference: PageItem])

array of varies=any TextBox.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

void TextBox.sendToBack ([reference: PageItem])

PageItem TextFrame.addPath (with: Array of PageItem)

void TextFrame.bringToFront ([reference: PageItem])

array of varies=any TextFrame.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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)

array of varies=any WMF.contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])

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])