LayoutArticleChild

Member of a group that is part of an article.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the ArticleChild. read-only
index number The index of the ArticleChild within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
itemRef PageItem The underlying page item read-only
parent Group The parent of the ArticleChild (a Group). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
 → EventListener
move(
to ​[, reference])
 → ArticleChild
removeEventListener(
eventType, handler ​[, captures])
 → bool
toSource(
)
 → string
toSpecifier(
)
 → string
addEventListener(
eventType, handler ​[, captures=false])
 → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
 → ArticleChild
Resolves the object specifier, creating an array of object references.
move(
to ​[, reference])
 → ArticleChild
Moves the ArticleChild to the specified location.
to LocationOptions The location relative to the reference object or within the containing object.
reference ArticleChild The reference object. Note: Required when the to value specifies before or after. (Optional)
removeEventListener(
eventType, handler ​[, captures=false])
 → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
 → string
Generates a string which, if executed, will return the ArticleChild.
toSpecifier(
)
 → string
Retrieves the object specifier.