TableRowCollection Object (JavaScript API for Word)

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

Contains the collection of the document's TableRow objects.

Properties

Property Type Description Req. Set
items TableRow A collection of tableRow objects. Read-only. 1.3

See property access examples.

Relationships

None

Methods

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

Syntax

tableRowCollectionObject.getFirst();

Parameters

None

Returns

TableRow

getFirstOrNullObject()

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

Syntax

tableRowCollectionObject.getFirstOrNullObject();

Parameters

None

Returns

TableRow

getItem(index: number)

Gets a table row object by its index in the collection.

Syntax

tableRowCollectionObject.getItem(index);

Parameters

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

Returns

TableRow

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