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

Hyperlink

A hyperlink.

Hierarchy

Document

Hyperlink

Properties

NameType AccessDescription
3 Reals (0 - 255)[] | UIColors[]
+25 more
 read/write The hyperlink border color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
HyperlinkAppearanceStyle
 read/write The hyperlink border style.
HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkTextDestination | HyperlinkURLDestination | ParagraphDestination read/write The text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly If true, the hyperlink is hidden.
HyperlinkAppearanceHighlight
 read/write The hyperlink highlight style.
Number readonly The unique ID of the Hyperlink.
Number readonly The index of the Hyperlink 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 Hyperlink.
Document readonly The parent of the Hyperlink (a Document).
Object read/write A property that allows setting of several properties at the same time.
HyperlinkPageItemSource | HyperlinkTextSource | CrossReferenceSource read/write The hyperlinked text or page item. Can return: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.
Boolean read/write If true, the Hyperlink is visible.
HyperlinkAppearanceWidth
 read/write The stroke weight of the hyperlink border.

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.
→ Hyperlink[]

Resolves the object specifier, creating an array of object references.

→ void

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

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

Deletes the Hyperlink.

→ 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.

→ void

Jumps to the hyperlink source.

→ String

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

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a Hyperlink.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 3

Method parameters that accept a Hyperlink.

Hyperlinks.itemByRange(from)Hyperlinks.nextItem(obj)Hyperlinks.previousItem(obj)

Return 14

Methods that return a Hyperlink.

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