Class

HyperlinkPageItemSource

 A hyperlinked page item.

QuickLinks

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

Hierarchy

Document

HyperlinkPageItemSource

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
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.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
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

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

Parameter	Type	Description
key	string	The key.

Array of HyperlinkPageItemSource getElements ()
Resolves the object specifier, creating an array of object references.

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.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void showSource ()
Jumps to the hyperlink source.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Hyperlink.source

Used in:

HyperlinkPageItemSource HyperlinkPageItemSources.nextItem (obj: HyperlinkPageItemSource)

HyperlinkPageItemSource HyperlinkPageItemSources.previousItem (obj: HyperlinkPageItemSource)

Return

Array of HyperlinkPageItemSource HyperlinkPageItemSource.getElements ()

HyperlinkPageItemSource HyperlinkPageItemSources.[] (index: number)

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

HyperlinkPageItemSource HyperlinkPageItemSources.anyItem ()

Array of HyperlinkPageItemSource HyperlinkPageItemSources.everyItem ()

HyperlinkPageItemSource HyperlinkPageItemSources.firstItem ()

HyperlinkPageItemSource HyperlinkPageItemSources.item (index: varies)

HyperlinkPageItemSource HyperlinkPageItemSources.itemByID (id: number)

HyperlinkPageItemSource HyperlinkPageItemSources.itemByName (name: string)

Array of HyperlinkPageItemSource HyperlinkPageItemSources.itemByRange (from: varies, to: varies)

HyperlinkPageItemSource HyperlinkPageItemSources.lastItem ()

HyperlinkPageItemSource HyperlinkPageItemSources.middleItem ()

HyperlinkPageItemSource HyperlinkPageItemSources.nextItem (obj: HyperlinkPageItemSource)

HyperlinkPageItemSource HyperlinkPageItemSources.previousItem (obj: HyperlinkPageItemSource)

Jongware, 23-Mar-2011 v3.0.3d

Contents :: Index