A hyperlink.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| borderColor | any | r/w | The hyperlink border color, specified as a UI color. Can return: Array of 3 Reals (0 – 255) or UIColors enumerator. |
| borderStyle | HyperlinkAppearanceStyle : SOLID DASHED |
r/w | The hyperlink border style. |
| destination | any | r/w | The text, page, or URL that the hyperlink points to. For information, see hyperlink page destination, hyperlink external page destination, hyperlink text destination, or hyperlink url destination. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or HyperlinkURLDestination. |
| hidden | bool | readonly | If true, the Hyperlink is hidden. |
| highlight | HyperlinkAppearanceHighlight : NONE INVERT OUTLINE INSET |
r/w | The hyperlink highlight style. |
| id | number | readonly | The unique ID of the Hyperlink. |
| index | number | readonly | The index of the Hyperlink 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 Hyperlink. |
| parent | Document | readonly | The parent of the Hyperlink (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| source | any | r/w | The hyperlinked text or page item. For information, see hyperlink page item source or hyperlink text source. Can return: HyperlinkPageItemSource or HyperlinkTextSource. |
| visible | bool | r/w | If true, the Hyperlink is visible. |
| width | HyperlinkAppearanceWidth : THIN MEDIUM THICK |
r/w | The hyperlink’s border weight. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of HyperlinkgetElements ()
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 Hyperlink.
void showDestination ()
Jumps to the hyperlink destination.
void showSource ()
Jumps to the hyperlink source.
string toSource ()
Generates a string which, if executed, will return the Hyperlink.
string toSpecifier ()
Retrieves the object specifier.
Element of:
GotoAnchorBehavior.anchorItem
Used in:
Hyperlinks.previousItem (
obj:
Hyperlink )
Hyperlinks.nextItem (
obj:
Hyperlink )
Returned by:
Array of Hyperlink Hyperlink .getElements (
)
Hyperlink Hyperlinks.add (
hyperlinkSource:
any[, hyperlinkDestination:
any][, withProperties:
Object]
)
Hyperlink Hyperlinks.anyItem (
)
Array of Hyperlink Hyperlinks.everyItem (
)
Hyperlink Hyperlinks.firstItem (
)
Hyperlink Hyperlinks.item (
index:
any
)
Hyperlink Hyperlinks.itemByID (
id:
number
)
Hyperlink Hyperlinks.itemByName (
name:
string
)
Array of Hyperlink Hyperlinks.itemByRange (
from:
any, to:
any
)
Hyperlink Hyperlinks.lastItem (
)
Hyperlink Hyperlinks.middleItem (
)
Hyperlink Hyperlinks.nextItem (
obj:
Hyperlink
)
Hyperlink Hyperlinks.previousItem (
obj:
Hyperlink
)