Class
HyperlinkTextDestination |
| | A hyperlink destination that is either text or an insertion point. |
QuickLinks |
extractLabel, insertLabel, remove, showDestination |
Hierarchy
|
|
Properties
| | Property | Type | Access | Description |
|---|
| destinationText | InsertionPoint |
r/w | The text or insertion point this destination points to. |
| hidden | bool |
readonly | If true, the hyperlink is hidden. |
| id | number |
readonly | The unique ID of the HyperlinkTextDestination. |
| index | number |
readonly | The index of the HyperlinkTextDestination 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 HyperlinkTextDestination. |
| parent | Document |
readonly | The parent of the HyperlinkTextDestination (a Document). |
| properties | Object |
r/w | A property that allows setting of several properties at the same time. |
|
Methods
| Instancesstring 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 HyperlinkTextDestination.
void showDestination ()
Jumps to the hyperlink destination.
|
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 |
HyperlinkTextDestination HyperlinkTextDestinations.add (destination:
Text[, withProperties:
Object])
|