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

InDesign Server CS5

Class

GotoPageBehaviors

 A collection of go to page behavior objects.

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

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

ParameterTypeDescription
indexnumberThe index.

GotoPageBehavior add ([withProperties: Object])
Creates a new GotoPageBehavior.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new GotoPageBehavior (Optional)

GotoPageBehavior anyItem ()
Returns any GotoPageBehavior in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromGotoPageBehavior
Long Integer
String
The GotoPageBehavior, index, or name at the beginning of the range. Can accept: GotoPageBehavior, Long Integer or String.
toGotoPageBehavior
Long Integer
String
The GotoPageBehavior, index, or name at the end of the range. Can accept: GotoPageBehavior, Long Integer or String.

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

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

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

ParameterTypeDescription
objGotoPageBehaviorThe GotoPageBehavior whose index comes before the desired GotoPageBehavior.

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

ParameterTypeDescription
objGotoPageBehaviorThe index of the GotoPageBehavior that follows the desired GotoPageBehavior.

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

Element of

Button.gotoPageBehaviors

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