Adobe InDesign CS5 Server (7.0) Object Model JS: Pages

InDesign Server CS5

Class

Pages

 A collection of pages.

QuickLinks

[], add, 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

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

ParameterTypeDescription
indexnumberThe index.

Page add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new page.

ParameterTypeDescription
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location of the new page relative to the reference object or within the document or spread. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
MasterSpread
Page
Spread
The reference object. Note: Required when the at parameter value specifies before or after. Can accept: Page, Spread, MasterSpread or Document. (Optional)
withPropertiesObjectInitial values for properties of the new Page (Optional)

Page anyItem ()
Returns any Page in the collection.

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

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

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

Page item (index: varies)
Returns the Page with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong Integer
Page
String
The Page, index, or name at the beginning of the range. Can accept: Page, Long Integer or String.
toLong Integer
Page
String
The Page, index, or name at the end of the range. Can accept: Page, Long Integer or String.

Page lastItem ()
Returns the last Page in the collection.

Page middleItem ()
Returns the middle Page in the collection.

Page nextItem (obj: Page)
Returns the Page whose index follows the specified Page in the collection.

ParameterTypeDescription
objPageThe Page whose index comes before the desired Page.

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

ParameterTypeDescription
objPageThe index of the Page that follows the desired Page.

string toSource ()
Generates a string which, if executed, will return the Page.

Element of

Document.pages

MasterSpread.pages

Spread.pages

Jongware, 23-Mar-2011 v3.0.3dContents :: Index