A hyperlink destination that is a document page.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| destinationPage | Page | r/w | The page that the hyperlink points to. |
| hidden | bool | readonly | If true, the HyperlinkPageDestination is hidden. |
| id | number | readonly | The unique ID of the HyperlinkPageDestination. |
| index | number | readonly | The index of the HyperlinkPageDestination within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the HyperlinkPageDestination. |
| nameManually | bool | r/w | If true or unspecified, allows a custom destination name; also does not update the name when the destination is moved to a different page. If false, uses the page number as the page destination name and makes the name property read-only for the destination object; also updates the name when the destination is moved to a different page. |
| parent | Document | readonly | The parent of the HyperlinkPageDestination (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 HyperlinkPageDestinationgetElements ()
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 HyperlinkPageDestination.
void showDestination ()
Jumps to the hyperlink destination.
string toSource ()
Generates a string which, if executed, will return the HyperlinkPageDestination.
string toSpecifier ()
Retrieves the object specifier.
Used in:
HyperlinkPageDestinations.previousItem (
obj:
HyperlinkPageDestination )
HyperlinkPageDestinations.nextItem (
obj:
HyperlinkPageDestination )
Returned by:
Array of HyperlinkPageDestination HyperlinkPageDestination .getElements (
)
HyperlinkPageDestination HyperlinkPageDestinations.add (
[destination:
Page][, withProperties:
Object]
)
HyperlinkPageDestination HyperlinkPageDestinations.anyItem (
)
Array of HyperlinkPageDestination HyperlinkPageDestinations.everyItem (
)
HyperlinkPageDestination HyperlinkPageDestinations.firstItem (
)
HyperlinkPageDestination HyperlinkPageDestinations.item (
index:
any
)
HyperlinkPageDestination HyperlinkPageDestinations.itemByID (
id:
number
)
HyperlinkPageDestination HyperlinkPageDestinations.itemByName (
name:
string
)
Array of HyperlinkPageDestination HyperlinkPageDestinations.itemByRange (
from:
any, to:
any
)
HyperlinkPageDestination HyperlinkPageDestinations.lastItem (
)
HyperlinkPageDestination HyperlinkPageDestinations.middleItem (
)
HyperlinkPageDestination HyperlinkPageDestinations.nextItem (
obj:
HyperlinkPageDestination
)
HyperlinkPageDestination HyperlinkPageDestinations.previousItem (
obj:
HyperlinkPageDestination
)