K4 InDesign Javascript API Documentation

LayoutArticleChildren

A collection of group items that are also part of an article.

Instance Properties

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

Methods

anyItem(
)
  → ArticleChild
count(
)
  → number
everyItem(
)
  → ArticleChild
firstItem(
)
  → ArticleChild
item(
index)
  → ArticleChild
itemByID(
id)
  → ArticleChild
itemByRange(
from, to)
  → ArticleChild
lastItem(
)
  → ArticleChild
middleItem(
)
  → ArticleChild
nextItem(
obj)
  → ArticleChild
previousItem(
obj)
  → ArticleChild
toSource(
)
  → string
anyItem(
)
  → ArticleChild
Returns any ArticleChild in the collection.
count(
)
  → number
Displays the number of elements in the ArticleChild.
everyItem(
)
  → ArticleChild
Returns every ArticleChild in the collection.
firstItem(
)
  → ArticleChild
Returns the first ArticleChild in the collection.
item(
index)
  → ArticleChild
Returns the ArticleChild with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → ArticleChild
Returns the ArticleChild with the specified ID.
id number The ID.
itemByRange(
from, to)
  → ArticleChild
Returns the ArticleChildren within the specified range.
from The ArticleChild, index, or name at the beginning of the range. Can accept: ArticleChild, Long Integer or String.
to The ArticleChild, index, or name at the end of the range. Can accept: ArticleChild, Long Integer or String.
lastItem(
)
  → ArticleChild
Returns the last ArticleChild in the collection.
middleItem(
)
  → ArticleChild
Returns the middle ArticleChild in the collection.
nextItem(
obj)
  → ArticleChild
Returns the ArticleChild whose index follows the specified ArticleChild in the collection.
obj ArticleChild The ArticleChild whose index comes before the desired ArticleChild.
previousItem(
obj)
  → ArticleChild
Returns the ArticleChild with the index previous to the specified index.
obj ArticleChild The index of the ArticleChild that follows the desired ArticleChild.
toSource(
)
  → string
Generates a string which, if executed, will return the ArticleChild.