Packagecom.adobe.indesign
Classpublic class PageReferences
InheritancePageReferences Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
PageReferences
Public Methods
 MethodDefined By
  
add(sourceParam:Text = null, pageReferenceTypeParam:PageReferenceType = null, pageReferenceLimitParam:Object = null, pageNumberStyleOverrideParam:CharacterStyle = null, withPropertiesParam:Object = null):PageReference
Creates a new page reference.
PageReferences
  
Returns any PageReference in the collection.
PageReferences
  
count():Number
Displays the number of elements in the PageReference.
PageReferences
  
everyItem():Object
Returns every PageReference in the collection.
PageReferences
 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 PageReference in the collection.
PageReferences
 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):PageReference
Returns the PageReference with the specified index or name.
PageReferences
  
itemByID(idParam:Number):PageReference
Returns the PageReference with the specified ID.
PageReferences
  
itemByName(nameParam:String = null):PageReference
Returns the PageReference with the specified name.
PageReferences
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the PageReferences within the specified range.
PageReferences
  
Returns the last PageReference in the collection.
PageReferences
  
Returns the middle PageReference in the collection.
PageReferences
  
Returns the PageReference whose index follows the specified PageReference in the collection.
PageReferences
  
Returns the PageReference with the index previous to the specified index.
PageReferences
 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
PageReferences
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
PageReferences
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(sourceParam:Text = null, pageReferenceTypeParam:PageReferenceType = null, pageReferenceLimitParam:Object = null, pageNumberStyleOverrideParam:CharacterStyle = null, withPropertiesParam:Object = null):PageReference

Creates a new page reference.

Parameters

sourceParam:Text (default = null) — (Text) The text or insertion point to which the page reference points.
 
pageReferenceTypeParam:PageReferenceType (default = null) — (PageReferenceType) The page number for an index page reference or the last page in an index page reference page range. (Optional)
 
pageReferenceLimitParam:Object (default = null) — (Object) The paragraph style or number of paragraphs or pages that defines the last page in a page range. Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. . Can accept: ParagraphStyle or Long Integer. (Optional)
 
pageNumberStyleOverrideParam:CharacterStyle (default = null) — (CharacterStyle) The style override for the page number. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new PageReference (Optional)

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

Returns any PageReference in the collection.

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

Displays the number of elements in the PageReference.

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

Returns every PageReference in the collection.

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

Returns the first PageReference in the collection.

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

Returns the PageReference with the specified index or name.

Parameters

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

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

Returns the PageReference with the specified ID.

Parameters

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

Returns
PageReference
itemByName()method 
public function itemByName(nameParam:String = null):PageReference

Returns the PageReference with the specified name.

Parameters

nameParam:String (default = null) — (String) The name.

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

Returns the PageReferences within the specified range.

Parameters

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

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

Returns the last PageReference in the collection.

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

Returns the middle PageReference in the collection.

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

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

Parameters

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

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

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

Parameters

idx:int

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

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

Parameters

index:int

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

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

Parameters

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

Returns
PageReference