HyperlinkTextDestination

A hyperlink destination that is either text or an insertion point.

Go to Property Listing | Method Listing

Methods:

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

Objects:

Boolean, InsertionPoint, Number, Object, String, Text

Property Listing

Property	Type	Access	Description
destinationText	InsertionPoint Text	read/write	The text or insertion point that the hyperlink points to. Can also accept: Text.
hidden	Boolean	readonly	If true, the hyperlink is hidden.
id	Number	readonly	The unique ID of the HyperlinkTextDestination.
index	Number	readonly	The index of the HyperlinkTextDestination 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 HyperlinkTextDestination.
parent	Document	readonly	The parent of the HyperlinkTextDestination (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.

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

undefined showDestination ()

Jumps to the hyperlink destination.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Bookmark.destination

Hyperlink.destination