Skip to main content

SectionCollection Class

A collection of the Section objects.

Declaration

export class SectionCollection extends Collection<Section>

Inherited Members

Inheritance

Collection<T>
SectionCollection

Methods

create(sectionBreakPosition, type) Method

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

Declaration

create(
    sectionBreakPosition: number,
    type: SectionBreakType
): Section

Parameters

Name Type Description
sectionBreakPosition number

The position of a section break.

type SectionBreakType

The type of a section break.

Returns

Type Description
Section

The newly created section.

find(position) Method

Returns a section that contains the specified position.

Declaration

find(
    position: number
): Section

Parameters

Name Type Description
position number

A position in a main sub-document.

Returns

Type Description
Section

A section object.