K4 InDesign Javascript API Documentation

Interactive ElementsClearFormBehaviors

A collection of clear form behavior objects.

Instance Properties

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

Methods

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