HyperlinkTextDestination
A hyperlink destination that is either text or an insertion point.
Superclass of ParagraphDestination
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| destinationText | InsertionPointText | r/w | The text or insertion point that the hyperlink points to. Can also accept: Text. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| 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. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| 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
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of HyperlinkTextDestination getElements ()
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 HyperlinkTextDestination.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void showDestination ()
Jumps to the hyperlink destination.
string toSource ()
Generates a string which, if executed, will return the HyperlinkTextDestination.
Element of
Bookmark.destination
GotoAnchorBehavior.anchorItem
Hyperlink.destination
Used in:
HyperlinkTextDestination HyperlinkTextDestinations.nextItem (obj: HyperlinkTextDestination)
HyperlinkTextDestination HyperlinkTextDestinations.previousItem (obj: HyperlinkTextDestination)
Return
Array of HyperlinkTextDestination HyperlinkTextDestination.getElements ()
HyperlinkTextDestination HyperlinkTextDestinations.[] (index: number)
HyperlinkTextDestination HyperlinkTextDestinations.add (destination: Text[, withProperties: Object])
HyperlinkTextDestination HyperlinkTextDestinations.anyItem ()
Array of HyperlinkTextDestination HyperlinkTextDestinations.everyItem ()
HyperlinkTextDestination HyperlinkTextDestinations.firstItem ()
HyperlinkTextDestination HyperlinkTextDestinations.item (index: varies)
HyperlinkTextDestination HyperlinkTextDestinations.itemByID (id: number)
HyperlinkTextDestination HyperlinkTextDestinations.itemByName (name: string)
Array of HyperlinkTextDestination HyperlinkTextDestinations.itemByRange (from: varies, to: varies)
HyperlinkTextDestination HyperlinkTextDestinations.lastItem ()
HyperlinkTextDestination HyperlinkTextDestinations.middleItem ()
HyperlinkTextDestination HyperlinkTextDestinations.nextItem (obj: HyperlinkTextDestination)
HyperlinkTextDestination HyperlinkTextDestinations.previousItem (obj: HyperlinkTextDestination)
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |