Class

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.

QuickLinks

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

Properties

Property	Type	Access	Description
length	number	readonly	The number of objects in the collection.

Methods

Instances

PageItem anyItem ()
Returns any PageItem in the collection.

number count ()
Displays the number of elements in the PageItem.

Array of PageItem everyItem ()
Returns every PageItem in the collection.

PageItem firstItem ()
Returns the first PageItem in the collection.

PageItem item (index: any)
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.

Array of PageItem itemByRange (from: any, to: any)
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.

Element of

Button.pageItems

Cell.pageItems

Character.pageItems

Document.pageItems

Footnote.pageItems

GraphicLine.pageItems

Group.pageItems

InsertionPoint.pageItems

Layer.pageItems

Line.pageItems

MasterSpread.pageItems

Oval.pageItems

Page.masterPageItems

Page.pageItems

PageItem.pageItems

Paragraph.pageItems

Polygon.pageItems

Rectangle.pageItems

Spread.pageItems

State.pageItems

Story.pageItems

Table.pageItems

Text.pageItems

TextColumn.pageItems

TextFrame.pageItems

TextStyleRange.pageItems

Word.pageItems

XMLElement.pageItems

Used in:

bool Book.packageForGoLive (location: File[, objects: Array of any])

bool Document.packageForGoLive (location: File[, objects: Array of any])

Asset Library.store (using: Array of any)

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index