K4 InDesign Javascript API Documentation

Interactive ElementsShowHideFieldsBehaviors

A collection of show/hide fields behavior objects.

Instance Properties

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

Methods

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