SectionCollection Object (JavaScript API for Word)

Word 2016, Word for iPad, Word for Mac, Word Online

Contains the collection of the document's section objects.

Properties

Property Type Description Req. Set
items Section[] A collection of section objects. Read-only. 1.1

Relationships

None

Methods

Method Return Type Description Req. Set
getFirst() Section Gets the first section in this collection. Throws if this collection is empty. 1.3
getFirstOrNullObject() Section Gets the first section in this collection. Returns a null object if this collection is empty. 1.3
getItem(index: number) Section Gets a section object by its index in the collection. 1.1
load(param: object) void Fills the proxy object created in JavaScript layer with property and object values specified in the parameter. 1.1

Method Details

getFirst()

Gets the first section in this collection. Throws if this collection is empty.

Syntax

sectionCollectionObject.getFirst();

Parameters

None

Returns

Section

getFirstOrNullObject()

Gets the first section in this collection. Returns a null object if this collection is empty.

Syntax

sectionCollectionObject.getFirstOrNullObject();

Parameters

None

Returns

Section

getItem(index: number)

Gets a section object by its index in the collection.

Syntax

sectionCollectionObject.getItem(index);

Parameters

Parameter Type Description
index number A number that identifies the index location of a section object.

Returns

Section

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter Type Description
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.

Returns

void