HyperlinkPageItemSource

A hyperlinked page item.

Go to Property Listing | Method Listing

Methods:

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

Objects:

Boolean, Number, Object, PageItem, String

Property Listing

Property	Type	Access	Description
hidden	Boolean	readonly	If true, the hyperlink is hidden.
id	Number	readonly	The unique ID of the HyperlinkPageItemSource.
index	Number	readonly	The index of the HyperlinkPageItemSource 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 HyperlinkPageItemSource.
parent	Document	readonly	The parent of the HyperlinkPageItemSource (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
sourcePageItem	PageItem	read/write	The hyperlinked page item.

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

undefined showSource ()

Jumps to the hyperlink source.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Hyperlink.source