HyperlinkPageItemSources

A collection of hyperlink page item sources.

Methods

HyperlinkPageItemSourceadd (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)

HyperlinkPageItemSourceanyItem ()
Returns any HyperlinkPageItemSource in the collection.

number count ()
Displays the number of elements in the HyperlinkPageItemSource.

Array of HyperlinkPageItemSourceeveryItem ()
Returns every HyperlinkPageItemSource in the collection.

HyperlinkPageItemSourcefirstItem ()
Returns the first HyperlinkPageItemSource in the collection.

HyperlinkPageItemSourceitem (index:
any)
Returns the HyperlinkPageItemSource with the specified index or name.

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

HyperlinkPageItemSourceitemByID (id:
number)
Returns the HyperlinkPageItemSource with the specified ID.

Parameter	Type	Description
id	number	The ID.

HyperlinkPageItemSourceitemByName (name:
string)
Returns the HyperlinkPageItemSource with the specified name.

Parameter	Type	Description
name	string	The name.

Array of HyperlinkPageItemSourceitemByRange (from:
any, to:
any)
Returns the HyperlinkPageItemSources within the specified range.

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

HyperlinkPageItemSourcelastItem ()
Returns the last HyperlinkPageItemSource in the collection.

HyperlinkPageItemSourcemiddleItem ()
Returns the middle HyperlinkPageItemSource in the collection.

HyperlinkPageItemSourcenextItem (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.

HyperlinkPageItemSourcepreviousItem (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.

Element of:

Document.hyperlinkPageItemSources