HyperlinkPageItemSource

A hyperlinked page item.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, PageItem, String

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

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.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

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

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

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

Event.parent

EventListener.parent

MutationEvent.parent

Return

HyperlinkPageItemSources.add()

HyperlinkPageItemSource.getElements()

HyperlinkPageItemSources.anyItem()

HyperlinkPageItemSources.everyItem()

HyperlinkPageItemSources.nextItem()

HyperlinkPageItemSources.previousItem()

HyperlinkPageItemSources.itemByID()

HyperlinkPageItemSources.item()

HyperlinkPageItemSources.[]()

HyperlinkPageItemSources.itemByName()

HyperlinkPageItemSources.itemByRange()

HyperlinkPageItemSources.firstItem()

HyperlinkPageItemSources.lastItem()

HyperlinkPageItemSources.middleItem()