K4 InDesign Javascript API Documentation

Interactive ElementsSubmitFormBehaviors

A collection of submit form behavior objects.

Instance Properties

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

Methods

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