Skip to main content
A newer version of this page is available. .

HyperlinkCollection Class

A collection of the Hyperlink objects.

Declaration

export class HyperlinkCollection extends Collection<Hyperlink>

Inherited Members

Inheritance

Collection<T>
HyperlinkCollection

Methods

create(position, hyperlinkInfo) Method

Creates a new Hyperlink object with the specified settings and adds it to the collection.

Declaration

create(
    position: number | IInterval,
    hyperlinkInfo: HyperlinkInfo
): Hyperlink

Parameters

Name Type Description
position number | IInterval

The hyperlink position or interval.

hyperlinkInfo HyperlinkInfo

An object that contains hyperlink settings.

Returns

Type Description
Hyperlink

The newly created hyperlink.