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

InDesign Server CS6

Class

ArticleMember

 An article member.

QuickLinks

addEventListener, getElements, move, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Article
ArticleMember
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the ArticleMember.
indexnumber readonlyThe index of the ArticleMember within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
itemRefPageItem readonlyThe underlying page item
parentArticle readonlyThe parent of the ArticleMember (a Article).
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 ArticleMember getElements ()
Resolves the object specifier, creating an array of object references.

ArticleMember move (to: LocationOptions[, reference: ArticleMember])
Moves the ArticleMember 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.
referenceArticleMemberThe reference object. Note: Required when the to value specifies before or after. (Optional)

void remove ()
Deletes the ArticleMember.

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 ArticleMember.

string toSpecifier ()
Retrieves the object specifier.

Used in:

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

ArticleMember ArticleMembers.add (itemRef: PageItem[, at: LocationOptions=LocationOptions.AT_END][, reference: ArticleMember][, withProperties: Object])

ArticleMember ArticleMembers.nextItem (obj: ArticleMember)

ArticleMember ArticleMembers.previousItem (obj: ArticleMember)

Return

Array of ArticleMember ArticleMember.getElements ()

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

ArticleMember ArticleMembers.[] (index: number)

ArticleMember ArticleMembers.add (itemRef: PageItem[, at: LocationOptions=LocationOptions.AT_END][, reference: ArticleMember][, withProperties: Object])

ArticleMember ArticleMembers.anyItem ()

Array of ArticleMember ArticleMembers.everyItem ()

ArticleMember ArticleMembers.firstItem ()

ArticleMember ArticleMembers.item (index: varies)

ArticleMember ArticleMembers.itemByID (id: number)

Array of ArticleMember ArticleMembers.itemByRange (from: varies, to: varies)

ArticleMember ArticleMembers.lastItem ()

ArticleMember ArticleMembers.middleItem ()

ArticleMember ArticleMembers.nextItem (obj: ArticleMember)

ArticleMember ArticleMembers.previousItem (obj: ArticleMember)

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