HyperlinkPageDestinations

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

HyperlinkPageDestination [] (index:Number)

Returns the HyperlinkPageDestination with the specified index.

Parameter	Type	Description
index	Number	The index.

HyperlinkPageDestination add (destination:Page, withProperties:Object)

Creates a new hyperlink page destination.

Parameter	Type	Description
destination	Page	The document page that the hyperlink points to. (Optional)
withProperties	Object	Initial values for properties of the new HyperlinkPageDestination (Optional)

HyperlinkPageDestination anyItem ()

Returns any HyperlinkPageDestination in the collection.

Number count ()

Displays the number of elements in the HyperlinkPageDestination.

HyperlinkPageDestination everyItem ()

Returns every HyperlinkPageDestination in the collection.

HyperlinkPageDestination firstItem ()

Returns the first HyperlinkPageDestination in the collection.

HyperlinkPageDestination item (index:Varies LongInteger String)

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

HyperlinkPageDestination itemByID (id:Number)

Returns the HyperlinkPageDestination with the specified ID.

Parameter	Type	Description
id	Number	The ID.

HyperlinkPageDestination itemByName (name:String)

Returns the HyperlinkPageDestination with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the HyperlinkPageDestinations within the specified range.

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

Parameter

Type

Description

from

HyperlinkPageDestination

LongInteger

String

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

HyperlinkPageDestination

LongInteger

String

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

HyperlinkPageDestination lastItem ()

Returns the last HyperlinkPageDestination in the collection.

HyperlinkPageDestination middleItem ()

Returns the middle HyperlinkPageDestination in the collection.

HyperlinkPageDestination nextItem (obj:HyperlinkPageDestination)

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

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

HyperlinkPageDestination previousItem (obj:HyperlinkPageDestination)

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

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

String toSource ()

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

Object of

Document.hyperlinkPageDestinations