SubDocumentsCollection Class

A collection of the SubDocument objects.

Declaration

export class SubDocumentsCollection extends Collection<SubDocument>

Inherited Members

count

getByIndex(index)

Inheritance

Collection<T>

SubDocumentsCollection

SubDocumentsCollectionBase

Properties

main Property

Returns the main sub-document.

Declaration

readonly main: SubDocument

Property Value

Type	Description
SubDocument	The main sub-document.

Remarks

Tip

You can acces the main sub-document’s properties directly at the document level.

JS

var mainSubDocumentLength = richEdit.document.subDocuments.main.length;
//or 
var mainSubDocumentLength = richEdit.document.length;

Methods

forEach(callback) Method

Performs the specified action on each element of the current sub-document collection.

Declaration

forEach(
    callback: (subDocument: SubDocument) => void
): void

Parameters

Name	Type	Description
callback	(subDocument: SubDocument) => void	The action to perform on each element of the collection.