Class
HyperlinkTextSource |
| A hyperlinked text object or insertion point. |
QuickLinks |
extractLabel, insertLabel, remove, showSource |
Hierarchy
|
|
Properties
| Property | Type | Access | Description |
hidden | bool |
readonly | If true, the hyperlink is hidden. |
id | number |
readonly | The unique ID of the HyperlinkTextSource. |
index | number |
readonly | The index of the HyperlinkTextSource 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 HyperlinkTextSource. |
parent | Document |
readonly | The parent of the HyperlinkTextSource (a Document). |
properties | Object |
r/w | A property that allows setting of several properties at the same time. |
sourceText | Text |
r/w | The hyperlinked text or insertion point. |
|
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 HyperlinkTextSource.
void showSource ()
Jumps to the hyperlink source.
|
Element of |
Hyperlink.source
|
Used in: | Hyperlink Hyperlinks.add
(hyperlinkSource:
any[, hyperlinkDestination:
any][, withProperties:
Object])
|
Return |
HyperlinkTextSource HyperlinkTextSources.add (source:
Text[, withProperties:
Object])
|