Packagecom.adobe.indesign
Classpublic class HyperlinkPageDestinations
InheritanceHyperlinkPageDestinations 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.
HyperlinkPageDestinations
Public Methods
 MethodDefined By
  
add(destinationParam:Page = null, withPropertiesParam:Object = null):HyperlinkPageDestination
Creates a new hyperlink page destination.
HyperlinkPageDestinations
  
Returns any HyperlinkPageDestination in the collection.
HyperlinkPageDestinations
  
count():Number
Displays the number of elements in the HyperlinkPageDestination.
HyperlinkPageDestinations
  
everyItem():Object
Returns every HyperlinkPageDestination in the collection.
HyperlinkPageDestinations
 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 HyperlinkPageDestination in the collection.
HyperlinkPageDestinations
 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):HyperlinkPageDestination
Returns the HyperlinkPageDestination with the specified index or name.
HyperlinkPageDestinations
  
Returns the HyperlinkPageDestination with the specified ID.
HyperlinkPageDestinations
  
itemByName(nameParam:String = null):HyperlinkPageDestination
Returns the HyperlinkPageDestination with the specified name.
HyperlinkPageDestinations
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the HyperlinkPageDestinations within the specified range.
HyperlinkPageDestinations
  
Returns the last HyperlinkPageDestination in the collection.
HyperlinkPageDestinations
  
Returns the middle HyperlinkPageDestination in the collection.
HyperlinkPageDestinations
  
Returns the HyperlinkPageDestination whose index follows the specified HyperlinkPageDestination in the collection.
HyperlinkPageDestinations
  
Returns the HyperlinkPageDestination with the index previous to the specified index.
HyperlinkPageDestinations
 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
HyperlinkPageDestinations
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
HyperlinkPageDestinations
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(destinationParam:Page = null, withPropertiesParam:Object = null):HyperlinkPageDestination

Creates a new hyperlink page destination.

Parameters

destinationParam:Page (default = null) — (Page) The document page that the hyperlink points to. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new HyperlinkPageDestination (Optional)

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

Returns any HyperlinkPageDestination in the collection.

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

Displays the number of elements in the HyperlinkPageDestination.

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

Returns every HyperlinkPageDestination in the collection.

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

Returns the first HyperlinkPageDestination in the collection.

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

Returns the HyperlinkPageDestination with the specified index or name.

Parameters

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

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

Returns the HyperlinkPageDestination with the specified ID.

Parameters

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

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

Returns the HyperlinkPageDestination with the specified name.

Parameters

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

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

Returns the HyperlinkPageDestinations within the specified range.

Parameters

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

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

Returns the last HyperlinkPageDestination in the collection.

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

Returns the middle HyperlinkPageDestination in the collection.

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

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

Parameters

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

Returns
HyperlinkPageDestination
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:HyperlinkPageDestination = null):HyperlinkPageDestination

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

Parameters

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

Returns
HyperlinkPageDestination