Edit

Share via

Word.Interfaces.BreakLoadOptions interface

Package:
word

Represents a break in a Word document. This could be a page, column, or section break.

Remarks

[ API set: WordApiDesktop 1.3 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

pageIndex

Returns the page number on which the break occurs.

pageIndex?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

range

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

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Word.Interfaces.RangeLoadOptions

Remarks

[ API set: WordApiDesktop 1.3 ]