TableCollection Object (JavaScript API for Word)

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

Contains the collection of the document's Table objects.

Properties

Property Type Description Req. Set
items Table A collection of table objects. Read-only. 1.3

See property access examples.

Relationships

None

Methods

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

Syntax

tableCollectionObject.getFirst();

Parameters

None

Returns

Table

getFirstOrNullObject()

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

Syntax

tableCollectionObject.getFirstOrNullObject();

Parameters

None

Returns

Table

getItem(index: number)

Gets a table object by its index in the collection.

Syntax

tableCollectionObject.getItem(index);

Parameters

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

Returns

Table

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