RangeCollection Object (JavaScript API for Word)

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

Contains a collection of range objects.

Properties

Property Type Description Req. Set
items Range A collection of range objects. Read-only. 1.1

See property access examples.

Relationships

None

Methods

Method Return Type Description Req. Set
getFirst() Range Gets the first range in this collection. Throws if this collection is empty. 1.3
getFirstOrNullObject() Range Gets the first range in this collection. Returns a null object if this collection is empty. 1.3
getItem(index: number) Range Gets a range 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 range in this collection. Throws if this collection is empty.

Syntax

rangeCollectionObject.getFirst();

Parameters

None

Returns

Range

getFirstOrNullObject()

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

Syntax

rangeCollectionObject.getFirstOrNullObject();

Parameters

None

Returns

Range

getItem(index: number)

Gets a range object by its index in the collection.

Syntax

rangeCollectionObject.getItem(index);

Parameters

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

Returns

Range

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