Adobe InDesign CS (3.0) Object Model JS: Hyperlink

InDesign CS

previous page next page

Class

Hyperlink

A hyperlink.

QuickLinks

extractLabel, insertLabel, remove, showDestination, showSource

Hierarchy

Document

Hyperlink

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	r/w	The text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or HyperlinkURLDestination.
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.
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	HyperlinkPageItemSource HyperlinkTextSource	r/w	The hyperlinked text or page item. Can return: HyperlinkPageItemSource or HyperlinkTextSource.
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

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

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.

void showDestination ()
Jumps to the hyperlink destination.

void showSource ()
Jumps to the hyperlink source.

Element of

GotoAnchorBehavior.anchorItem

Return

Hyperlink Hyperlinks.add (hyperlinkSource: any[, hyperlinkDestination: any][, withProperties: Object])

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index

previous page start next page