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 ArticleMember. | read-only |
index | number The index of the ArticleMember 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 | Article The parent of the ArticleMember (a Article). | read-only |
properties | Object A property that allows setting of several properties at the same time. | read-write |
Methods
addEventListener( | eventType, handler [, captures]) |
→ EventListener |
getElements( | ) |
→ ArticleMember |
move( | to [, reference]) |
→ ArticleMember |
remove( | ) |
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( )→ ArticleMember -
Resolves the object specifier, creating an array of object references.
-
move( to [, reference])→ ArticleMember -
Moves the ArticleMember to the specified location.
to
LocationOptions The location relative to the reference object or within the containing object. reference
ArticleMember The reference object. Note: Required when the to value specifies before or after. (Optional) -
remove( ) -
Deletes the ArticleMember.
-
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 ArticleMember.
-
toSpecifier( )→ string -
Retrieves the object specifier.