K4 InDesign Javascript API Documentation

Interactive ElementsGotoPageBehaviors

A collection of go to page behavior objects.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[withProperties])
  → GotoPageBehavior
anyItem(
)
  → GotoPageBehavior
count(
)
  → number
everyItem(
)
  → GotoPageBehavior
firstItem(
)
  → GotoPageBehavior
item(
index)
  → GotoPageBehavior
itemByID(
id)
  → GotoPageBehavior
itemByName(
name)
  → GotoPageBehavior
itemByRange(
from, to)
  → GotoPageBehavior
lastItem(
)
  → GotoPageBehavior
middleItem(
)
  → GotoPageBehavior
nextItem(
obj)
  → GotoPageBehavior
previousItem(
obj)
  → GotoPageBehavior
toSource(
)
  → string
add(
[withProperties])
  → GotoPageBehavior
Creates a new GotoPageBehavior.
withProperties Object Initial values for properties of the new GotoPageBehavior (Optional)
anyItem(
)
  → GotoPageBehavior
Returns any GotoPageBehavior in the collection.
count(
)
  → number
Displays the number of elements in the GotoPageBehavior.
everyItem(
)
  → GotoPageBehavior
Returns every GotoPageBehavior in the collection.
firstItem(
)
  → GotoPageBehavior
Returns the first GotoPageBehavior in the collection.
item(
index)
  → GotoPageBehavior
Returns the GotoPageBehavior with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → GotoPageBehavior
Returns the GotoPageBehavior with the specified ID.
id number The ID.
itemByName(
name)
  → GotoPageBehavior
Returns the GotoPageBehavior with the specified name.
name string The name.
itemByRange(
from, to)
  → GotoPageBehavior
Returns the GotoPageBehaviors within the specified range.
from The GotoPageBehavior, index, or name at the beginning of the range. Can accept: GotoPageBehavior, Long Integer or String.
to The GotoPageBehavior, index, or name at the end of the range. Can accept: GotoPageBehavior, Long Integer or String.
lastItem(
)
  → GotoPageBehavior
Returns the last GotoPageBehavior in the collection.
middleItem(
)
  → GotoPageBehavior
Returns the middle GotoPageBehavior in the collection.
nextItem(
obj)
  → GotoPageBehavior
Returns the GotoPageBehavior whose index follows the specified GotoPageBehavior in the collection.
obj GotoPageBehavior The GotoPageBehavior whose index comes before the desired GotoPageBehavior.
previousItem(
obj)
  → GotoPageBehavior
Returns the GotoPageBehavior with the index previous to the specified index.
obj GotoPageBehavior The index of the GotoPageBehavior that follows the desired GotoPageBehavior.
toSource(
)
  → string
Generates a string which, if executed, will return the GotoPageBehavior.