Word.Interfaces.BreakData interface

An interface describing the data returned by calling break.toJSON().

Properties

pageIndex	Returns the page number on which the break occurs.
range	Returns a `Range` object that represents the portion of the document that's contained in the break.

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the page number on which the break occurs.

pageIndex?: number;

number

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns a Range object that represents the portion of the document that's contained in the break.

range?: Word.Interfaces.RangeData;