K4 InDesign Javascript API Documentation

Interactive ElementsPrintFormBehaviors

A collection of print form behavior objects.

Instance Properties

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

Methods

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