HyperlinkPageItemSources

A collection of hyperlink page item sources.

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

HyperlinkPageItemSource [] (index:Number)

Returns the HyperlinkPageItemSource with the specified index.

Parameter	Type	Description
index	Number	The index.

HyperlinkPageItemSource add (source:PageItem, withProperties:Object)

Creates a new hyperlink page item source.

Parameter	Type	Description
source	PageItem	The page item to hyperlink.
withProperties	Object	Initial values for properties of the new HyperlinkPageItemSource (Optional)

HyperlinkPageItemSource anyItem ()

Returns any HyperlinkPageItemSource in the collection.

Number count ()

Displays the number of elements in the HyperlinkPageItemSource.

HyperlinkPageItemSource everyItem ()

Returns every HyperlinkPageItemSource in the collection.

HyperlinkPageItemSource firstItem ()

Returns the first HyperlinkPageItemSource in the collection.

HyperlinkPageItemSource item (index:Varies LongInteger String)

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

HyperlinkPageItemSource itemByID (id:Number)

Returns the HyperlinkPageItemSource with the specified ID.

Parameter	Type	Description
id	Number	The ID.

HyperlinkPageItemSource itemByName (name:String)

Returns the HyperlinkPageItemSource with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the HyperlinkPageItemSources within the specified range.

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

Parameter

Type

Description

from

HyperlinkPageItemSource

LongInteger

String

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

HyperlinkPageItemSource

LongInteger

String

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

HyperlinkPageItemSource lastItem ()

Returns the last HyperlinkPageItemSource in the collection.

HyperlinkPageItemSource middleItem ()

Returns the middle HyperlinkPageItemSource in the collection.

HyperlinkPageItemSource nextItem (obj:HyperlinkPageItemSource)

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

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

HyperlinkPageItemSource previousItem (obj:HyperlinkPageItemSource)

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

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

String toSource ()

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

Object of

Document.hyperlinkPageItemSources