K4 InDesign Javascript API Documentation

Interactive ElementsOpenFileBehaviors

A collection of open file behavior objects.

Instance Properties

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

Methods

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