Class

HyperlinkPageItemSource

 A hyperlinked page item.

QuickLinks

extractLabel, insertLabel, remove, showSource

Hierarchy

Document

HyperlinkPageItemSource

Properties

Property	Type	Access	Description
hidden	bool	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	r/w	A property that can be set to any string.
name	string	r/w	The name of the HyperlinkPageItemSource.
parent	Document	readonly	The parent of the HyperlinkPageItemSource (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
sourcePageItem	PageItem	r/w	The hyperlinked page item.

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

void showSource ()
Jumps to the hyperlink source.

Element of

Hyperlink.source

Used in:

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

Return

HyperlinkPageItemSource HyperlinkPageItemSources.add (source: PageItem[, withProperties: Object])

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index