ParagraphDestinations

A collection of paragraph destinations.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

ParagraphDestination [] (index:Number)

Returns the ParagraphDestination with the specified index.

Parameter	Type	Description
index	Number	The index.

ParagraphDestination add (destination:Text, withProperties:Object)

Creates a new paragraph destination.

Parameter	Type	Description
destination	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.
withProperties	Object	Initial values for properties of the new ParagraphDestination (Optional)

ParagraphDestination anyItem ()

Returns any ParagraphDestination in the collection.

Number count ()

Displays the number of elements in the ParagraphDestination.

ParagraphDestination everyItem ()

Returns every ParagraphDestination in the collection.

ParagraphDestination firstItem ()

Returns the first ParagraphDestination in the collection.

ParagraphDestination item (index:Varies LongInteger String)

Returns the ParagraphDestination with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

ParagraphDestination itemByID (id:Number)

Returns the ParagraphDestination with the specified ID.

Parameter	Type	Description
id	Number	The ID.

ParagraphDestination itemByName (name:String)

Returns the ParagraphDestination with the specified name.

Parameter	Type	Description
name	String	The name.

ParagraphDestination itemByRange (from:Varies LongInteger ParagraphDestination String, to:Varies LongInteger ParagraphDestination String)

Returns the ParagraphDestinations within the specified range.

Parameter	Type	Description
from	LongInteger ParagraphDestination String	The ParagraphDestination, index, or name at the beginning of the range. Can accept: ParagraphDestination, Long Integer or String.
to	LongInteger ParagraphDestination String	The ParagraphDestination, index, or name at the end of the range. Can accept: ParagraphDestination, Long Integer or String.

Parameter

Type

Description

from

LongInteger

ParagraphDestination

String

The ParagraphDestination, index, or name at the beginning of the range. Can accept: ParagraphDestination, Long Integer or String.

LongInteger

ParagraphDestination

String

The ParagraphDestination, index, or name at the end of the range. Can accept: ParagraphDestination, Long Integer or String.

ParagraphDestination lastItem ()

Returns the last ParagraphDestination in the collection.

ParagraphDestination middleItem ()

Returns the middle ParagraphDestination in the collection.

ParagraphDestination nextItem (obj:ParagraphDestination)

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

Parameter	Type	Description
obj	ParagraphDestination	The ParagraphDestination whose index comes before the desired ParagraphDestination.

ParagraphDestination previousItem (obj:ParagraphDestination)

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

Parameter	Type	Description
obj	ParagraphDestination	The index of the ParagraphDestination that follows the desired ParagraphDestination.

String toSource ()

Generates a string which, if executed, will return the ParagraphDestination.

Object of

Document.paragraphDestinations