Articles

A collection of articles.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

Article [] (index:Number)

Returns the Article with the specified index.

Parameter	Type	Description
index	Number	The index.

Article add (name:String, articleExportStatus:Boolean, [at:LocationOptions=LocationOptions], reference:Article, withProperties:Object)

Creates a new Article

Parameter	Type	Description
name	String	The article name (Optional)
articleExportStatus	Boolean	The article's export status (Optional)
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	Article	The reference object. Note: Required when the to value specifies before or after. (Optional)
withProperties	Object	Initial values for properties of the new Article (Optional)

Article anyItem ()

Returns any Article in the collection.

Number count ()

Displays the number of elements in the Article.

Article everyItem ()

Returns every Article in the collection.

Article firstItem ()

Returns the first Article in the collection.

Article item (index:Varies LongInteger String)

Returns the Article with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

Article itemByID (id:Number)

Returns the Article with the specified ID.

Parameter	Type	Description
id	Number	The ID.

Article itemByName (name:String)

Returns the Article with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the Articles within the specified range.

Parameter	Type	Description
from	Article LongInteger String	The Article, index, or name at the beginning of the range. Can accept: Article, Long Integer or String.
to	Article LongInteger String	The Article, index, or name at the end of the range. Can accept: Article, Long Integer or String.

Parameter

Type

Description

from

Article

LongInteger

String

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

Article

LongInteger

String

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

Article lastItem ()

Returns the last Article in the collection.

Article middleItem ()

Returns the middle Article in the collection.

Article nextItem (obj:Article)

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

Parameter	Type	Description
obj	Article	The Article whose index comes before the desired Article.

Article previousItem (obj:Article)

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

Parameter	Type	Description
obj	Article	The index of the Article that follows the desired Article.

String toSource ()

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

Object of

Document.articles