A hyperlink destination that is a page in a document other than the document that contains the hyperlink source. For information on hyperlink sources, hyperlink page item source or hyperlink text source.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| destinationPageIndex | number | r/w | The index of the page that the hyperlink destination points to. Note: Valid only when hyperlink destination is an external page. |
| documentPath | File | r/w | The path to the document that the hyperlink destination points to. |
| hidden | bool | readonly | If true, the HyperlinkExternalPageDestination is hidden. |
| id | number | readonly | The unique ID of the HyperlinkExternalPageDestination. |
| index | number | readonly | The index of the HyperlinkExternalPageDestination within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| name | string | readonly | The name of the HyperlinkExternalPageDestination. |
| parent | Document | readonly | The parent of the HyperlinkExternalPageDestination (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| viewBounds | Array of number | r/w | The view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid only when view setting is fixed. |
| viewPercentage | number | r/w | The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed. |
| viewSetting | HyperlinkDestinationPageSetting : FIXED FIT_VIEW FIT_WINDOW FIT_WIDTH FIT_HEIGHT FIT_VISIBLE INHERIT_ZOOM |
r/w | The destination page size when the page is reached by clicking the hyperlink. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of HyperlinkExternalPageDestinationgetElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the HyperlinkExternalPageDestination.
void showDestination ()
Jumps to the hyperlink destination.
string toSource ()
Generates a string which, if executed, will return the HyperlinkExternalPageDestination.
string toSpecifier ()
Retrieves the object specifier.
Used in:
HyperlinkExternalPageDestinations.previousItem (
obj:
HyperlinkExternalPageDestination )
HyperlinkExternalPageDestinations.nextItem (
obj:
HyperlinkExternalPageDestination )
Returned by:
Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestination .getElements (
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.add (
[destination:
Page][, withProperties:
Object]
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.anyItem (
)
Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.everyItem (
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.firstItem (
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.item (
index:
any
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByID (
id:
number
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByName (
name:
string
)
Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByRange (
from:
any, to:
any
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.lastItem (
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.middleItem (
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.nextItem (
obj:
HyperlinkExternalPageDestination
)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.previousItem (
obj:
HyperlinkExternalPageDestination
)