K4 InDesign Javascript API Documentation

LayoutArticleMembers

A collection of article members.

Instance Properties

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

Methods

add(
itemRef ​[, at] ​[, reference] ​[, withProperties])
  → ArticleMember
anyItem(
)
  → ArticleMember
count(
)
  → number
everyItem(
)
  → ArticleMember
firstItem(
)
  → ArticleMember
item(
index)
  → ArticleMember
itemByID(
id)
  → ArticleMember
itemByRange(
from, to)
  → ArticleMember
lastItem(
)
  → ArticleMember
middleItem(
)
  → ArticleMember
nextItem(
obj)
  → ArticleMember
previousItem(
obj)
  → ArticleMember
toSource(
)
  → string
add(
itemRef ​[, at=LocationOptions.AT_END] ​[, reference] ​[, withProperties])
  → ArticleMember
Adds a new member.
itemRef PageItem page item to be added to article
at LocationOptions The location relative to the reference object or within the containing object. (Optional)
reference ArticleMember The reference object. Note: Required when the to value specifies before or after. (Optional)
withProperties Object Initial values for properties of the new ArticleMember (Optional)
anyItem(
)
  → ArticleMember
Returns any ArticleMember in the collection.
count(
)
  → number
Displays the number of elements in the ArticleMember.
everyItem(
)
  → ArticleMember
Returns every ArticleMember in the collection.
firstItem(
)
  → ArticleMember
Returns the first ArticleMember in the collection.
item(
index)
  → ArticleMember
Returns the ArticleMember with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → ArticleMember
Returns the ArticleMember with the specified ID.
id number The ID.
itemByRange(
from, to)
  → ArticleMember
Returns the ArticleMembers within the specified range.
from The ArticleMember, index, or name at the beginning of the range. Can accept: ArticleMember, Long Integer or String.
to The ArticleMember, index, or name at the end of the range. Can accept: ArticleMember, Long Integer or String.
lastItem(
)
  → ArticleMember
Returns the last ArticleMember in the collection.
middleItem(
)
  → ArticleMember
Returns the middle ArticleMember in the collection.
nextItem(
obj)
  → ArticleMember
Returns the ArticleMember whose index follows the specified ArticleMember in the collection.
obj ArticleMember The ArticleMember whose index comes before the desired ArticleMember.
previousItem(
obj)
  → ArticleMember
Returns the ArticleMember with the index previous to the specified index.
obj ArticleMember The index of the ArticleMember that follows the desired ArticleMember.
toSource(
)
  → string
Generates a string which, if executed, will return the ArticleMember.