Class
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. extractLabel, insertLabel, remove, showDestination
HyperlinkExternalPageDestination
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| destinationPageIndex | number | r/w | The index of the page this destination points to |
| documentPath | string | r/w | The path to the document this destination points to |
| hidden | bool | readonly | If true, the hyperlink 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 Measurement Unit (Number or String) | 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 (ignored unless view setting is fixed) |
| viewSetting | HyperlinkDestinationPageSetting: HyperlinkDestinationPageSetting.FIXED HyperlinkDestinationPageSetting.FIT_VIEW HyperlinkDestinationPageSetting.FIT_WINDOW HyperlinkDestinationPageSetting.FIT_WIDTH HyperlinkDestinationPageSetting.FIT_HEIGHT HyperlinkDestinationPageSetting.FIT_VISIBLE HyperlinkDestinationPageSetting.INHERIT_ZOOM |
r/w | The destination page size when the page is reached by clicking the hyperlink. |
Methods
Instances
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
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.
Element of
Bookmark.destination
Hyperlink.destination
Used in:
Bookmark Bookmarks.add (destination: any[, withProperties: Object])
Hyperlink Hyperlinks.add (hyperlinkSource: any[, hyperlinkDestination: any][, withProperties: Object])
Return
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.add ([destination: Page][, withProperties: Object])
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |