Adobe InDesign CS6 (8.0) Object Model JS: PageItems

InDesign CS6

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

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

PageItem [] (index: number)
Returns the PageItem with the specified index.

ParameterTypeDescription
indexnumberThe index.

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: varies)
Returns the PageItem with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

PageItem itemByID (id: number)
Returns the PageItem with the specified ID.

ParameterTypeDescription
idnumberThe ID.

PageItem itemByName (name: string)
Returns the PageItem with the specified name.

ParameterTypeDescription
namestringThe name.

Array of PageItem itemByRange (from: varies, to: varies)
Returns the PageItems within the specified range.

ParameterTypeDescription
fromLong Integer
PageItem
String
The PageItem, index, or name at the beginning of the range. Can accept: PageItem, Long Integer or String.
toLong Integer
PageItem
String
The PageItem, index, or name at the end of the range. Can accept: PageItem, Long Integer 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.

ParameterTypeDescription
objPageItemThe PageItem whose index comes before the desired PageItem.

PageItem previousItem (obj: PageItem)
Returns the PageItem with the index previous to the specified index.

ParameterTypeDescription
objPageItemThe 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

CheckBox.pageItems

ComboBox.pageItems

Document.pageItems

Footnote.pageItems

GraphicLine.pageItems

Group.pageItems

InsertionPoint.pageItems

Layer.pageItems

Line.pageItems

ListBox.pageItems

MasterSpread.pageItems

Movie.pageItems

MultiStateObject.pageItems

Oval.pageItems

Page.masterPageItems

Page.pageItems

Paragraph.pageItems

PlaceGun.pageItems

Polygon.pageItems

RadioButton.pageItems

Rectangle.pageItems

SignatureField.pageItems

Snippet.pageItems

Sound.pageItems

SplineItem.pageItems

Spread.pageItems

State.pageItems

Story.pageItems

Table.pageItems

Text.pageItems

TextBox.pageItems

TextColumn.pageItems

TextFrame.pageItems

TextStyleRange.pageItems

Word.pageItems

XMLElement.pageItems

XmlStory.pageItems

Jongware, 28-Apr-2012 v3.0.3hContents :: Index