TableRowCollection Object (JavaScript API for OneNote)

Applies to: OneNote Online

Contains a collection of TableRow objects.

To provide feedback on this API, you can file an issue in GitHub.

Properties

Property Type Description
count int Returns the number of table rows in this collection. Read-only.
items TableRow A collection of tableRow objects. Read-only.

See property access examples.

Relationships

None

Methods

Method Return Type Description
getItem(index: number or string) TableRow Gets a table row object by ID or by its index in the collection. Read-only.
getItemAt(index: number) TableRow Gets a table row at its position in the collection.
load(param: object) void Fills the proxy object created in the JavaScript layer with property and object values specified in the parameter.

Method details

getItem(index: number or string)

Gets a table row object by ID or by its index in the collection. Read-only.

Syntax

tableRowCollectionObject.getItem(index);

Parameters

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

Returns

TableRow


getItemAt(index: number)

Gets a table row at its position in the collection.

Syntax

tableRowCollectionObject.getItemAt(index);

Parameters

Parameter Type Description
index number Index value of the object to be retrieved. Zero-indexed.

Returns

TableRow


load(param: object)

Fills the proxy object created in the 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 a delimited string or an array. Or, provide loadOption object.

Returns

Void


arameters-2">Parameters
Parameter Type Description
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.

Returns

void

TML Page Content End -->