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

InDesign Server CS6

Class

ArticleChild

 Member of a group that is part of an article.

QuickLinks

addEventListener, getElements, move, removeEventListener, toSource, toSpecifier

Hierarchy

Group
ArticleChild
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the ArticleChild.
indexnumber readonlyThe index of the ArticleChild within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
itemRefPageItem readonlyThe underlying page item
parentGroup readonlyThe parent of the ArticleChild (a Group).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of ArticleChild getElements ()
Resolves the object specifier, creating an array of object references.

ArticleChild move (to: LocationOptions[, reference: ArticleChild])
Moves the ArticleChild to the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceArticleChildThe reference object. Note: Required when the to value specifies before or after. (Optional)

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

ArticleChild ArticleChild.move (to: LocationOptions[, reference: ArticleChild])

ArticleChild ArticleChildren.nextItem (obj: ArticleChild)

ArticleChild ArticleChildren.previousItem (obj: ArticleChild)

Return

Array of ArticleChild ArticleChild.getElements ()

ArticleChild ArticleChild.move (to: LocationOptions[, reference: ArticleChild])

ArticleChild ArticleChildren.[] (index: number)

ArticleChild ArticleChildren.anyItem ()

Array of ArticleChild ArticleChildren.everyItem ()

ArticleChild ArticleChildren.firstItem ()

ArticleChild ArticleChildren.item (index: varies)

ArticleChild ArticleChildren.itemByID (id: number)

Array of ArticleChild ArticleChildren.itemByRange (from: varies, to: varies)

ArticleChild ArticleChildren.lastItem ()

ArticleChild ArticleChildren.middleItem ()

ArticleChild ArticleChildren.nextItem (obj: ArticleChild)

ArticleChild ArticleChildren.previousItem (obj: ArticleChild)

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