HyperlinkTextSource

A hyperlinked text object or insertion point.

Methods:

extractLabel, insertLabel, remove, showSource

Objects:

Boolean, Number, Object, String, Text

Property Listing

Property

Type

Access

Description

hidden

Boolean

readonly

If true, the hyperlink is hidden.

id

Number

readonly

The unique ID of the HyperlinkTextSource.

index

Number

readonly

The index of the HyperlinkTextSource 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 HyperlinkTextSource.

parent

Document

readonly

The parent of the HyperlinkTextSource (a Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

sourceText

Text

read/write

The hyperlinked text or insertion point.

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

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

undefined showSource ()

Jumps to the hyperlink source.

Object of

Hyperlink.source

Return

HyperlinkTextSources.add()