K4 InDesign Javascript API Documentation

LayoutArticles

A collection of articles.

Instance Properties

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

Methods

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