Collection<T> Class

Serves as a base for classes maintaining a collection of items.

Declaration

export abstract class Collection<T>

Type Parameters

The type of items.

|

Inheritance

Collection<T> FontCollection

ParagraphCollection

BookmarkCollection<TBookmark>

RangePermissionCollection

FieldCollection

HyperlinkCollection

SubDocumentCollection<T>

SectionCollection

ListCollection

Properties

count Property

Gets the number of items contained in the collection.

Declaration

get count(): number

Property Value

The number of items.

|

Methods

getByIndex(index) Method

Gets an item with the specified index.

Declaration

getByIndex(
    index: number
): T | null

Parameters

The index of an item in the collection.

|

Returns

An object that is the item at the specified index. null if an item with the specified index is not found.

|

Remarks

• JS

// Gets URLs of all hyperlinks in the main sub-document
var hyperlinks = richEdit.document.hyperlinks;
var hyperlinkUrls = [];
for(var i = 0, hyperlink; hyperlink = hyperlinks.getByIndex(i); i++)
    if (hyperlink.hyperlinkInfo.url)
        hyperlinkUrls.push(hyperlink.hyperlinkInfo.url);