ArticleMember

An article member.

Go to Property Listing | Method Listing

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, PageItem

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the ArticleMember.

index

Number

readonly

The index of the ArticleMember within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

itemRef

PageItem

readonly

The underlying page item

parent

Article

readonly

The parent of the ArticleMember (a Article).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

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.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

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)

undefined remove ()

Deletes the ArticleMember.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the ArticleMember.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

ArticleMembers.add()

ArticleMember.move()

ArticleMember.getElements()

ArticleMembers.anyItem()

ArticleMembers.everyItem()

ArticleMembers.nextItem()

ArticleMembers.previousItem()

ArticleMembers.itemByID()

ArticleMembers.item()

ArticleMembers.[]()

ArticleMembers.itemByRange()

ArticleMembers.firstItem()

ArticleMembers.lastItem()

ArticleMembers.middleItem()