ArticleMembers
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
ArticleMember [] (index:
number)
Returns the ArticleMember with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
ArticleMember add (itemRef:
PageItem[, at:
LocationOptions=LocationOptions.AT_END][, reference:
ArticleMember][, withProperties:
Object])
Adds a new member.
| Parameter | Type | Description |
|---|---|---|
| itemRef | PageItem | page item to be added to article |
| at | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING 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.
Array of ArticleMember everyItem ()
Returns every ArticleMember in the collection.
ArticleMember firstItem ()
Returns the first ArticleMember in the collection.
ArticleMember item (index:
varies)
Returns the ArticleMember with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer 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. |
Array of ArticleMember itemByRange (from:
varies, to:
varies)
Returns the ArticleMembers within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | ArticleMember Long Integer String | The ArticleMember, index, or name at the beginning of the range. Can accept: ArticleMember, Long Integer or String. |
| to | ArticleMember Long Integer 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.
Element of
Article.articleMembers
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |