Hyperlink

A hyperlink.

Go to Property Listing | Method Listing

Methods:

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

Objects:

Boolean, HyperlinkAppearanceHighlight, HyperlinkAppearanceStyle, HyperlinkAppearanceWidth, HyperlinkExternalPageDestination, HyperlinkPageDestination, HyperlinkPageItemSource, HyperlinkTextDestination, HyperlinkTextSource, HyperlinkURLDestination, Number, Object, 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	read/write	The text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or HyperlinkURLDestination.
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.
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	read/write	The hyperlinked text or page item. Can return: HyperlinkPageItemSource or HyperlinkTextSource.
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

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

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

undefined showDestination ()

Jumps to the hyperlink destination.

undefined showSource ()

Jumps to the hyperlink source.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

GotoAnchorBehavior.anchorItem

Return

Hyperlinks.add()

Hyperlinks.anyItem()

Hyperlinks.everyItem()

Hyperlinks.nextItem()

Hyperlinks.previousItem()

Hyperlinks.itemByID()

Hyperlinks.item()

Hyperlinks.itemByName()

Hyperlinks.itemByRange()

Hyperlinks.firstItem()

Hyperlinks.lastItem()

Hyperlinks.middleItem()