A hyperlink destination that is a URL.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| destinationURL | string | r/w | The URL the hyperlink points to. |
| hidden | bool | readonly | If true, the HyperlinkURLDestination is hidden. |
| id | number | readonly | The unique ID of the HyperlinkURLDestination. |
| index | number | readonly | The index of the HyperlinkURLDestination 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 HyperlinkURLDestination. |
| parent | Document | readonly | The parent of the HyperlinkURLDestination (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of HyperlinkURLDestinationgetElements ()
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 HyperlinkURLDestination.
void showDestination ()
Jumps to the hyperlink destination.
string toSource ()
Generates a string which, if executed, will return the HyperlinkURLDestination.
string toSpecifier ()
Retrieves the object specifier.
Used in:
HyperlinkURLDestinations.previousItem (
obj:
HyperlinkURLDestination )
HyperlinkURLDestinations.nextItem (
obj:
HyperlinkURLDestination )
Returned by:
Array of HyperlinkURLDestination HyperlinkURLDestination .getElements (
)
HyperlinkURLDestination HyperlinkURLDestinations.add (
[destination:
string][, withProperties:
Object]
)
HyperlinkURLDestination HyperlinkURLDestinations.anyItem (
)
Array of HyperlinkURLDestination HyperlinkURLDestinations.everyItem (
)
HyperlinkURLDestination HyperlinkURLDestinations.firstItem (
)
HyperlinkURLDestination HyperlinkURLDestinations.item (
index:
any
)
HyperlinkURLDestination HyperlinkURLDestinations.itemByID (
id:
number
)
HyperlinkURLDestination HyperlinkURLDestinations.itemByName (
name:
string
)
Array of HyperlinkURLDestination HyperlinkURLDestinations.itemByRange (
from:
any, to:
any
)
HyperlinkURLDestination HyperlinkURLDestinations.lastItem (
)
HyperlinkURLDestination HyperlinkURLDestinations.middleItem (
)
HyperlinkURLDestination HyperlinkURLDestinations.nextItem (
obj:
HyperlinkURLDestination
)
HyperlinkURLDestination HyperlinkURLDestinations.previousItem (
obj:
HyperlinkURLDestination
)