ArticleMembers

A collection of article members.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

ArticleMember [] (index:Number)

Returns the ArticleMember with the specified index.

Parameter

Type

Description

index

Number

The index.

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

Adds a new member.

Parameter

Type

Description

itemRef

PageItem

page item to be added to article

at

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. (Optional)

(default: LocationOptions.AT_END)

reference

ArticleMember

The reference object. Note: Required when the to value specifies before or after. (Optional)

withProperties

Object

Initial values for properties of the new ArticleMember (Optional)

ArticleMember anyItem ()

Returns any ArticleMember in the collection.

Number count ()

Displays the number of elements in the ArticleMember.

ArticleMember everyItem ()

Returns every ArticleMember in the collection.

ArticleMember firstItem ()

Returns the first ArticleMember in the collection.

ArticleMember item (index:Varies LongInteger String)

Returns the ArticleMember with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

ArticleMember itemByID (id:Number)

Returns the ArticleMember with the specified ID.

Parameter

Type

Description

id

Number

The ID.

ArticleMember itemByRange (from:Varies ArticleMember LongInteger String, to:Varies ArticleMember LongInteger String)

Returns the ArticleMembers within the specified range.

Parameter

Type

Description

from

ArticleMember

LongInteger

String

The ArticleMember, index, or name at the beginning of the range. Can accept: ArticleMember, Long Integer or String.

to

ArticleMember

LongInteger

String

The ArticleMember, index, or name at the end of the range. Can accept: ArticleMember, Long Integer or String.

ArticleMember lastItem ()

Returns the last ArticleMember in the collection.

ArticleMember middleItem ()

Returns the middle ArticleMember in the collection.

ArticleMember nextItem (obj:ArticleMember)

Returns the ArticleMember whose index follows the specified ArticleMember in the collection.

Parameter

Type

Description

obj

ArticleMember

The ArticleMember whose index comes before the desired ArticleMember.

ArticleMember previousItem (obj:ArticleMember)

Returns the ArticleMember with the index previous to the specified index.

Parameter

Type

Description

obj

ArticleMember

The index of the ArticleMember that follows the desired ArticleMember.

String toSource ()

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

Object of

Article.articleMembers