Packagecom.adobe.indesign
Classpublic class ArticleMembers
InheritanceArticleMembers Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5.5



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
ArticleMembers
Public Methods
 MethodDefined By
  
add(itemRefParam:PageItem = null, atParam:LocationOptions = null, referenceParam:ArticleMember = null, withPropertiesParam:Object = null):ArticleMember
Adds a new member.
ArticleMembers
  
Returns any ArticleMember in the collection.
ArticleMembers
  
count():Number
Displays the number of elements in the ArticleMember.
ArticleMembers
  
everyItem():Object
Returns every ArticleMember in the collection.
ArticleMembers
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
  
Returns the first ArticleMember in the collection.
ArticleMembers
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
item(indexParam:Object = null):ArticleMember
Returns the ArticleMember with the specified index or name.
ArticleMembers
  
itemByID(idParam:Number):ArticleMember
Returns the ArticleMember with the specified ID.
ArticleMembers
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the ArticleMembers within the specified range.
ArticleMembers
  
Returns the last ArticleMember in the collection.
ArticleMembers
  
Returns the middle ArticleMember in the collection.
ArticleMembers
  
Returns the ArticleMember whose index follows the specified ArticleMember in the collection.
ArticleMembers
  
Returns the ArticleMember with the index previous to the specified index.
ArticleMembers
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
ArticleMembers
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
ArticleMembers
Property Detail
lengthproperty
length:Number  [read-only]

Since : CS5.5

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(itemRefParam:PageItem = null, atParam:LocationOptions = null, referenceParam:ArticleMember = null, withPropertiesParam:Object = null):ArticleMember

Since : CS5.5

Adds a new member.

Parameters

itemRefParam:PageItem (default = null) — (PageItem) page item to be added to article
 
atParam:LocationOptions (default = null) — (LocationOptions) The location relative to the reference object or within the containing object. (Optional)
 
referenceParam:ArticleMember (default = null) — (ArticleMember) The reference object. Note: Required when the to value specifies before or after. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new ArticleMember (Optional)

Returns
ArticleMember
anyItem()method 
public function anyItem():ArticleMember

Since : CS5.5

Returns any ArticleMember in the collection.

Returns
ArticleMember
count()method 
public function count():Number

Since : CS5.5

Displays the number of elements in the ArticleMember.

Returns
Number
everyItem()method 
public function everyItem():Object

Since : CS5.5

Returns every ArticleMember in the collection.

Returns
Object
firstItem()method 
public function firstItem():ArticleMember

Since : CS5.5

Returns the first ArticleMember in the collection.

Returns
ArticleMember
item()method 
public function item(indexParam:Object = null):ArticleMember

Since : CS5.5

Returns the ArticleMember with the specified index or name.

Parameters

indexParam:Object (default = null) — (Object) The index or name. Can accept: Long Integer or String.

Returns
ArticleMember
itemByID()method 
public function itemByID(idParam:Number):ArticleMember

Since : CS5.5

Returns the ArticleMember with the specified ID.

Parameters

idParam:Number (default = NaN) — (Number) The ID.

Returns
ArticleMember
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

Since : CS5.5

Returns the ArticleMembers within the specified range.

Parameters

fromParam:Object (default = null) — (Object) The ArticleMember, index, or name at the beginning of the range. Can accept: ArticleMember, Long Integer or String.
 
toParam:Object (default = null) — (Object) The ArticleMember, index, or name at the end of the range. Can accept: ArticleMember, Long Integer or String.

Returns
Object
lastItem()method 
public function lastItem():ArticleMember

Since : CS5.5

Returns the last ArticleMember in the collection.

Returns
ArticleMember
middleItem()method 
public function middleItem():ArticleMember

Since : CS5.5

Returns the middle ArticleMember in the collection.

Returns
ArticleMember
nextItem()method 
public function nextItem(objParam:ArticleMember = null):ArticleMember

Since : CS5.5

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

Parameters

objParam:ArticleMember (default = null) — (ArticleMember) The ArticleMember whose index comes before the desired ArticleMember.

Returns
ArticleMember
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Since : CS5.5

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Since : CS5.5

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:ArticleMember = null):ArticleMember

Since : CS5.5

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

Parameters

objParam:ArticleMember (default = null) — (ArticleMember) The index of the ArticleMember that follows the desired ArticleMember.

Returns
ArticleMember