HyperlinkPageDestinations
QuickLinks
Properties
Property | Type | Access | Description |
---|---|---|---|
length | number | readonly | The number of objects in the collection. |
Methods
Instances
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.
Array of HyperlinkPageDestination everyItem ()
Returns every HyperlinkPageDestination in the collection.
HyperlinkPageDestination firstItem ()
Returns the first HyperlinkPageDestination in the collection.
HyperlinkPageDestination item (index:
varies)
Returns the HyperlinkPageDestination with the specified index or name.
Parameter | Type | Description |
---|---|---|
index | Long Integer 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. |
Array of HyperlinkPageDestination itemByRange (from:
varies, to:
varies)
Returns the HyperlinkPageDestinations within the specified range.
Parameter | Type | Description |
---|---|---|
from | HyperlinkPageDestination Long Integer String | The HyperlinkPageDestination, index, or name at the beginning of the range. Can accept: HyperlinkPageDestination, Long Integer or String. |
to | HyperlinkPageDestination Long Integer 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.
Element of
Document.hyperlinkPageDestinations
Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |