Adobe InDesign CS6 Server (8.0) Object Model JS: ArticleChildren

InDesign Server CS6

Class

ArticleChildren

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

QuickLinks

[], anyItem, count, everyItem, firstItem, item, itemByID, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

ArticleChild [] (index: number)
Returns the ArticleChild with the specified index.

ParameterTypeDescription
indexnumberThe index.

ArticleChild anyItem ()
Returns any ArticleChild in the collection.

number count ()
Displays the number of elements in the ArticleChild.

Array of ArticleChild everyItem ()
Returns every ArticleChild in the collection.

ArticleChild firstItem ()
Returns the first ArticleChild in the collection.

ArticleChild item (index: varies)
Returns the ArticleChild with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

ArticleChild itemByID (id: number)
Returns the ArticleChild with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Array of ArticleChild itemByRange (from: varies, to: varies)
Returns the ArticleChildren within the specified range.

ParameterTypeDescription
fromArticleChild
Long Integer
String
The ArticleChild, index, or name at the beginning of the range. Can accept: ArticleChild, Long Integer or String.
toArticleChild
Long Integer
String
The ArticleChild, index, or name at the end of the range. Can accept: ArticleChild, Long Integer or String.

ArticleChild lastItem ()
Returns the last ArticleChild in the collection.

ArticleChild middleItem ()
Returns the middle ArticleChild in the collection.

ArticleChild nextItem (obj: ArticleChild)
Returns the ArticleChild whose index follows the specified ArticleChild in the collection.

ParameterTypeDescription
objArticleChildThe ArticleChild whose index comes before the desired ArticleChild.

ArticleChild previousItem (obj: ArticleChild)
Returns the ArticleChild with the index previous to the specified index.

ParameterTypeDescription
objArticleChildThe index of the ArticleChild that follows the desired ArticleChild.

string toSource ()
Generates a string which, if executed, will return the ArticleChild.

Element of

Group.articleChildren

Jongware, 28-Apr-2012 v3.0.3iContents :: Index