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

Creates a new paragraph destination.

Parameters

destinationParam:Text (default = null) — (Text) The text or insertion point inside the paragraph that the cross reference points to. The insertion point is always adjusted to the beginning of the paragraph.
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new ParagraphDestination (Optional)

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

Returns any ParagraphDestination in the collection.

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

Displays the number of elements in the ParagraphDestination.

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

Returns every ParagraphDestination in the collection.

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

Returns the first ParagraphDestination in the collection.

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

Returns the ParagraphDestination with the specified index or name.

Parameters

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

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

Returns the ParagraphDestination with the specified ID.

Parameters

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

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

Returns the ParagraphDestination with the specified name.

Parameters

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

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

Returns the ParagraphDestinations within the specified range.

Parameters

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

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

Returns the last ParagraphDestination in the collection.

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

Returns the middle ParagraphDestination in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
ParagraphDestination