PageItems

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.

Methods:

anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

PageItem anyItem ()

Returns any PageItem in the collection.

Number count ()

Displays the number of elements in the PageItem.

PageItem everyItem ()

Returns every PageItem in the collection.

PageItem firstItem ()

Returns the first PageItem in the collection.

PageItem item (index:Varies Long String)

Returns the PageItem with the specified index or name.

Parameter

Type

Description

index

Long

String

The index or name. Can accept: Long or String.

PageItem itemByID (id:Number)

Returns the PageItem with the specified ID.

Parameter

Type

Description

id

Number

The ID.

PageItem itemByName (name:String)

Returns the PageItem with the specified name.

Parameter

Type

Description

name

String

The name.

PageItem itemByRange (from:Varies Long PageItem String, to:Varies Long PageItem String)

Returns the PageItems within the specified range.

Parameter

Type

Description

from

Long

PageItem

String

The PageItem, index, or name at the beginning of the range. Can accept: PageItem, Long or String.

to

Long

PageItem

String

The PageItem, index, or name at the end of the range. Can accept: PageItem, Long or String.

PageItem lastItem ()

Returns the last PageItem in the collection.

PageItem middleItem ()

Returns the middle PageItem in the collection.

PageItem nextItem (obj:PageItem)

Returns the PageItem whose index follows the specified PageItem in the collection.

Parameter

Type

Description

obj

PageItem

The PageItem whose index comes before the desired PageItem.

PageItem previousItem (obj:PageItem)

Returns the PageItem with the index previous to the specified index.

Parameter

Type

Description

obj

PageItem

The index of the PageItem that follows the desired PageItem.

String toSource ()

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

Object of

Document.pageItems

Button.pageItems

State.pageItems

Layer.pageItems

Spread.pageItems

Page.pageItems

MasterSpread.pageItems

PageItem.pageItems

Oval.pageItems

Rectangle.pageItems

GraphicLine.pageItems

Polygon.pageItems

Group.pageItems

Cell.pageItems

Table.pageItems

Text.pageItems

Character.pageItems

Word.pageItems

Line.pageItems

TextColumn.pageItems

Paragraph.pageItems

TextStyleRange.pageItems

InsertionPoint.pageItems

TextFrame.pageItems

Story.pageItems

Footnote.pageItems

XMLElement.pageItems