HyperlinkTextDestinations

A collection of hyperlink text 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

HyperlinkTextDestination [] (index:Number)

Returns the HyperlinkTextDestination with the specified index.

Parameter	Type	Description
index	Number	The index.

HyperlinkTextDestination add (destination:Text, withProperties:Object)

Creates a new hyperlink text destination.

Parameter	Type	Description
destination	Text	The text or insertion point location that the hyperlink points to.
withProperties	Object	Initial values for properties of the new HyperlinkTextDestination (Optional)

HyperlinkTextDestination anyItem ()

Returns any HyperlinkTextDestination in the collection.

Number count ()

Displays the number of elements in the HyperlinkTextDestination.

HyperlinkTextDestination everyItem ()

Returns every HyperlinkTextDestination in the collection.

HyperlinkTextDestination firstItem ()

Returns the first HyperlinkTextDestination in the collection.

HyperlinkTextDestination item (index:Varies LongInteger String)

Returns the HyperlinkTextDestination 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.

HyperlinkTextDestination itemByID (id:Number)

Returns the HyperlinkTextDestination with the specified ID.

Parameter	Type	Description
id	Number	The ID.

HyperlinkTextDestination itemByName (name:String)

Returns the HyperlinkTextDestination with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the HyperlinkTextDestinations within the specified range.

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

Parameter

Type

Description

from

HyperlinkTextDestination

LongInteger

String

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

HyperlinkTextDestination

LongInteger

String

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

HyperlinkTextDestination lastItem ()

Returns the last HyperlinkTextDestination in the collection.

HyperlinkTextDestination middleItem ()

Returns the middle HyperlinkTextDestination in the collection.

HyperlinkTextDestination nextItem (obj:HyperlinkTextDestination)

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

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

HyperlinkTextDestination previousItem (obj:HyperlinkTextDestination)

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

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

String toSource ()

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

Object of

Document.hyperlinkTextDestinations