InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

HyperlinkTextDestination

A hyperlink destination that is either text or an insertion point.

Extended byParagraphDestination
Hierarchy

Document

HyperlinkTextDestination

Properties

NameType AccessDescription
InsertionPoint | Text read/write The text or insertion point that the hyperlink points to. Can also accept: Text.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly If true, the hyperlink is hidden.
Number readonly The unique ID of the HyperlinkTextDestination.
Number readonly The index of the HyperlinkTextDestination within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the HyperlinkTextDestination.
Document readonly The parent of the HyperlinkTextDestination (a Document).
Object read/write A property that allows setting of several properties at the same time.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Gets the label value associated with the specified key.

key String The key.
→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the HyperlinkTextDestination.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Jumps to the hyperlink destination.

→ String

Generates a string which, if executed, will return the HyperlinkTextDestination.

→ String

Retrieves the object specifier.

Object of 6

Properties elsewhere that hold a HyperlinkTextDestination.

Bookmark.destinationEvent.parentEventListener.parentGotoAnchorBehavior.anchorItemHyperlink.destinationMutationEvent.parent

Parameter of 5

Method parameters that accept a HyperlinkTextDestination.

Bookmarks.add(destination)HyperlinkTextDestinations.itemByRange(from)HyperlinkTextDestinations.nextItem(obj)HyperlinkTextDestinations.previousItem(obj)Hyperlinks.add(hyperlinkDestination)

Return 14

Methods that return a HyperlinkTextDestination.

HyperlinkTextDestination.getElements()HyperlinkTextDestinations.[]()HyperlinkTextDestinations.add()HyperlinkTextDestinations.anyItem()HyperlinkTextDestinations.everyItem()HyperlinkTextDestinations.firstItem()HyperlinkTextDestinations.item()HyperlinkTextDestinations.itemByID()HyperlinkTextDestinations.itemByName()HyperlinkTextDestinations.itemByRange()HyperlinkTextDestinations.lastItem()HyperlinkTextDestinations.middleItem()HyperlinkTextDestinations.nextItem()HyperlinkTextDestinations.previousItem()