Hyperlinks

A collection of hyperlinks.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Hyperlink [] (index:Number)

Returns the Hyperlink with the specified index.

Parameter

Type

Description

index

Number

The index.

Hyperlink add (hyperlinkSource:Varies HyperlinkPageItemSource HyperlinkTextSource CrossReferenceSource, hyperlinkDestination:Varies HyperlinkExternalPageDestination HyperlinkPageDestination HyperlinkTextDestination HyperlinkURLDestination OrderedarraycontainingfileName:String DataLinkClassId:LongInteger DestinationUid:LongInteger DirectoryId:LongInteger Volumn:String ParagraphDestination, withProperties:Object)

Creates a new hyperlink.

Parameter

Type

Description

hyperlinkSource

HyperlinkPageItemSource

HyperlinkTextSource

CrossReferenceSource

The hyperlinked object. Can accept: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.

hyperlinkDestination

HyperlinkExternalPageDestination

HyperlinkPageDestination

HyperlinkTextDestination

HyperlinkURLDestination

OrderedarraycontainingfileName:String

DataLinkClassId:LongInteger

DestinationUid:LongInteger

DirectoryId:LongInteger

Volumn:String

ParagraphDestination

The destination that the hyperlink points to. Can accept: Ordered array containing fileName:String, volumn:String, directoryId:Long Integer, dataLinkClassId:Long Integer, destinationUid:Long Integer, HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination. (Optional)

withProperties

Object

Initial values for properties of the new Hyperlink (Optional)

Hyperlink anyItem ()

Returns any Hyperlink in the collection.

Number count ()

Displays the number of elements in the Hyperlink.

Hyperlink everyItem ()

Returns every Hyperlink in the collection.

Hyperlink firstItem ()

Returns the first Hyperlink in the collection.

Hyperlink item (index:Varies LongInteger String)

Returns the Hyperlink with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

Hyperlink itemByID (id:Number)

Returns the Hyperlink with the specified ID.

Parameter

Type

Description

id

Number

The ID.

Hyperlink itemByName (name:String)

Returns the Hyperlink with the specified name.

Parameter

Type

Description

name

String

The name.

Hyperlink itemByRange (from:Varies Hyperlink LongInteger String, to:Varies Hyperlink LongInteger String)

Returns the Hyperlinks within the specified range.

Parameter

Type

Description

from

Hyperlink

LongInteger

String

The Hyperlink, index, or name at the beginning of the range. Can accept: Hyperlink, Long Integer or String.

to

Hyperlink

LongInteger

String

The Hyperlink, index, or name at the end of the range. Can accept: Hyperlink, Long Integer or String.

Hyperlink lastItem ()

Returns the last Hyperlink in the collection.

Hyperlink middleItem ()

Returns the middle Hyperlink in the collection.

Hyperlink nextItem (obj:Hyperlink)

Returns the Hyperlink whose index follows the specified Hyperlink in the collection.

Parameter

Type

Description

obj

Hyperlink

The Hyperlink whose index comes before the desired Hyperlink.

Hyperlink previousItem (obj:Hyperlink)

Returns the Hyperlink with the index previous to the specified index.

Parameter

Type

Description

obj

Hyperlink

The index of the Hyperlink that follows the desired Hyperlink.

String toSource ()

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

Object of

Document.hyperlinks