Hyperlink

Methods:

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

Objects:

Boolean, CrossReferenceSource, EventListeners, Events, HyperlinkAppearanceHighlight, HyperlinkAppearanceStyle, HyperlinkAppearanceWidth, HyperlinkExternalPageDestination, HyperlinkPageDestination, HyperlinkPageItemSource, HyperlinkTextDestination, HyperlinkTextSource, HyperlinkURLDestination, Number, Object, ParagraphDestination, String, UIColors,

Property Listing

Property	Type	Access	Description
borderColor	Array of 3 Reals (0 - 255) UIColors	read/write	The hyperlink border color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
borderStyle	HyperlinkAppearanceStyle HyperlinkAppearanceStyle.DASHED HyperlinkAppearanceStyle.SOLID	read/write	The hyperlink border style.
destination	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	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
hidden	Boolean	readonly	If true, the hyperlink is hidden.
highlight	HyperlinkAppearanceHighlight HyperlinkAppearanceHighlight.INSET HyperlinkAppearanceHighlight.INVERT HyperlinkAppearanceHighlight.NONE HyperlinkAppearanceHighlight.OUTLINE	read/write	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	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the Hyperlink.
parent	Document	readonly	The parent of the Hyperlink (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
source	HyperlinkPageItemSource HyperlinkTextSource CrossReferenceSource	read/write	The hyperlinked text or page item. Can return: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.
visible	Boolean	read/write	If true, the Hyperlink is visible.
width	HyperlinkAppearanceWidth HyperlinkAppearanceWidth.MEDIUM HyperlinkAppearanceWidth.THICK HyperlinkAppearanceWidth.THIN	read/write	The stroke weight of the hyperlink border.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

Hyperlink getElements ()

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

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

undefined remove ()

Deletes the Hyperlink.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
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. (Optional) (default: false)