Class

Hyperlink

A hyperlink.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, showDestination, showSource, toSource, toSpecifier

Hierarchy

Document

Hyperlink

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
borderColor	3 Reals (0 - 255) UIColors	r/w	The hyperlink border color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
borderStyle	HyperlinkAppearanceStyle: HyperlinkAppearanceStyle.SOLID HyperlinkAppearanceStyle.DASHED	r/w	The hyperlink border style.
destination	HyperlinkExternalPageDestination HyperlinkPageDestination HyperlinkTextDestination HyperlinkURLDestination ParagraphDestination	r/w	The text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
hidden	bool	readonly	If true, the hyperlink is hidden.
highlight	HyperlinkAppearanceHighlight: HyperlinkAppearanceHighlight.NONE HyperlinkAppearanceHighlight.INVERT HyperlinkAppearanceHighlight.OUTLINE HyperlinkAppearanceHighlight.INSET	r/w	The hyperlink highlight style.
id	number	readonly	The unique ID of the Hyperlink.
index	number	readonly	The index of the Hyperlink 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 Hyperlink.
parent	Document	readonly	The parent of the Hyperlink (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
source	CrossReferenceSource HyperlinkPageItemSource HyperlinkTextSource	r/w	The hyperlinked text or page item. Can return: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.
visible	bool	r/w	If true, the Hyperlink is visible.
width	HyperlinkAppearanceWidth: HyperlinkAppearanceWidth.THIN HyperlinkAppearanceWidth.MEDIUM HyperlinkAppearanceWidth.THICK	r/w	The stroke weight of the hyperlink border.

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

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)