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

HyperlinkTextSource

A hyperlinked text object or insertion point.

Extended byCrossReferenceSource
Hierarchy

Document

HyperlinkTextSource

Properties

NameType AccessDescription
CharacterStyle read/write Character style of the hyperlink text source.
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 HyperlinkTextSource.
Number readonly The index of the HyperlinkTextSource 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 HyperlinkTextSource.
Document readonly The parent of the HyperlinkTextSource (a Document).
Object read/write A property that allows setting of several properties at the same time.
Text read/write The hyperlinked text or insertion point.

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

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

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

→ String

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

→ String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a HyperlinkTextSource.

Event.parentEventListener.parentHyperlink.sourceMutationEvent.parent

Parameter of 4

Method parameters that accept a HyperlinkTextSource.

HyperlinkTextSources.itemByRange(from)HyperlinkTextSources.nextItem(obj)HyperlinkTextSources.previousItem(obj)Hyperlinks.add(hyperlinkSource)

Return 22

Methods that return a HyperlinkTextSource.

Character.findHyperlinks()HyperlinkTextSource.getElements()HyperlinkTextSources.[]()HyperlinkTextSources.add()HyperlinkTextSources.anyItem()HyperlinkTextSources.everyItem()HyperlinkTextSources.firstItem()HyperlinkTextSources.item()HyperlinkTextSources.itemByID()HyperlinkTextSources.itemByName()HyperlinkTextSources.itemByRange()HyperlinkTextSources.lastItem()HyperlinkTextSources.middleItem()HyperlinkTextSources.nextItem()HyperlinkTextSources.previousItem()InsertionPoint.findHyperlinks()Line.findHyperlinks()Paragraph.findHyperlinks()Text.findHyperlinks()TextColumn.findHyperlinks()TextStyleRange.findHyperlinks()Word.findHyperlinks()